Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add troubleshooting page #3830

Merged
merged 3 commits into from
Jun 25, 2021
Merged

Add troubleshooting page #3830

merged 3 commits into from
Jun 25, 2021

Conversation

johnnycase
Copy link
Contributor

site/content/docs: Add troubleshooting page
Created a troubleshooting page and added a troubleshooting section to the main Docs page.

Updates #3816
Signed-off-by: johnnycase johneverettcase@gmail.com

Signed-off-by: johnnycase <johneverettcase@gmail.com>
@johnnycase johnnycase requested a review from a team as a code owner June 22, 2021 16:22
@johnnycase johnnycase requested review from stevesloka and danehans and removed request for a team June 22, 2021 16:22
@codecov
Copy link

codecov bot commented Jun 22, 2021

Codecov Report

Merging #3830 (7bb7b39) into main (0a94c00) will decrease coverage by 0.02%.
The diff coverage is 0.00%.

❗ Current head 7bb7b39 differs from pull request most recent head e63a298. Consider uploading reports for the commit e63a298 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             main    #3830      +/-   ##
==========================================
- Coverage   75.83%   75.81%   -0.03%     
==========================================
  Files         107      107              
  Lines        7338     7340       +2     
==========================================
  Hits         5565     5565              
- Misses       1652     1654       +2     
  Partials      121      121              
Impacted Files Coverage Δ
cmd/contour/serve.go 10.74% <0.00%> (-0.06%) ⬇️

Copy link
Member

@stevesloka stevesloka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one small nit, overall looks like a good start to build out the different sections.

We might also want to include the FAQ (https://projectcontour.io/resources/faq/) page to link to or merge together someway.

site/content/docs/main/troubleshooting.md Outdated Show resolved Hide resolved
Co-authored-by: Steve Sloka <steve@stevesloka.com>
Copy link
Member

@youngnick youngnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks.

@youngnick
Copy link
Member

Ah, it looks like your most recent commit needs the signoff @johnnycase. Personally, I use git commit --amend -as to fix this sort of thing up, that will update the last commit to have the signed-off-by line. You'll need to git push --force afterwards too. Or, if you did that with the online edit, unfortunately you need to fix this by pulling, editing locally, and repushing. Sorry, this is a Github limitation.

It's actually better to do stuff locally rather than use the UI for this reason, sadly.

Once the CI passes and the DCO is sorted, I'll merge this for you.

@johnnycase
Copy link
Contributor Author

johnnycase commented Jun 24, 2021

i see, i'll make those edits and resubmit, thanks!

I pushed the changes, I also found the same edit mentioned by Steve should be applied to two other pages, so I included those as well. Let me know if anything else is needed.

Signed-off-by: johnnycase <johneverettcase@gmail.com>
@youngnick
Copy link
Member

youngnick commented Jun 25, 2021

Dang, it looks like the second commit here is still not signed off. In this case, it's okay, because I'm going to squash that one away anyway. Thanks very much!

@youngnick youngnick merged commit 379fdbe into projectcontour:main Jun 25, 2021
@johnnycase
Copy link
Contributor Author

Thanks for merging! Sorry about the commit not being signed off. The command I used was git commit -s -m "Message" should I add anything there?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants