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

move guides into versioned documentation #4977

Merged
merged 8 commits into from
Jan 13, 2023

Conversation

skriss
Copy link
Member

@skriss skriss commented Jan 12, 2023

Closes #4396.

Couple notes:

  • The versioned guides exist in "main" and "v1.23.2" docs only
  • I updated the top-level site header nav: Guides is no longer listed there, and Documentation moved left to be more prominent. Guides are now in the documentation TOC.
  • I left the existing non-versioned guides in place to avoid breaking old links, but I updated as many links as I could find (i.e. from the versioned docs) to point to the new versioned guides
  • I deleted a few guides that were no longer relevant

Still clicking around to make sure I didn't break anything.

Preview site: https://deploy-preview-4977--projectcontour.netlify.app/

…in/guides

Signed-off-by: Steve Kriss <krisss@vmware.com>
Signed-off-by: Steve Kriss <krisss@vmware.com>
Signed-off-by: Steve Kriss <krisss@vmware.com>
Signed-off-by: Steve Kriss <krisss@vmware.com>
Signed-off-by: Steve Kriss <krisss@vmware.com>
@skriss
Copy link
Member Author

skriss commented Jan 12, 2023

One thing I don't like is how long the nav/TOC is getting for docs, it just makes it hard to navigate. Would be nice to have the sections within the TOC be collapsible. ref. #3815

@codecov
Copy link

codecov bot commented Jan 12, 2023

Codecov Report

Merging #4977 (75cec94) into main (63dd999) will decrease coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #4977      +/-   ##
==========================================
- Coverage   77.61%   77.60%   -0.01%     
==========================================
  Files         140      140              
  Lines       16871    16875       +4     
==========================================
+ Hits        13094    13096       +2     
- Misses       3520     3522       +2     
  Partials      257      257              
Impacted Files Coverage Δ
internal/sorter/sorter.go 97.95% <0.00%> (-0.52%) ⬇️
cmd/contour/serve.go 22.31% <0.00%> (-0.04%) ⬇️
pkg/config/parameters.go 86.61% <0.00%> (ø)
internal/envoy/v3/ratelimit.go 100.00% <0.00%> (ø)
internal/xdscache/v3/listener.go 91.33% <0.00%> (+0.02%) ⬆️
cmd/contour/servecontext.go 80.91% <0.00%> (+0.05%) ⬆️

Signed-off-by: Steve Kriss <krisss@vmware.com>
@skriss skriss added the release-note/docs A documentation change for the release notes. label Jan 12, 2023
Signed-off-by: Steve Kriss <krisss@vmware.com>
@skriss skriss marked this pull request as ready for review January 12, 2023 22:40
@skriss skriss requested a review from a team as a code owner January 12, 2023 22:40
@skriss skriss requested review from tsaarni, stevesloka, sunjayBhatia and pnbrown and removed request for a team January 12, 2023 22:40
@skriss
Copy link
Member Author

skriss commented Jan 12, 2023

I think this is looking pretty good, marked ready for review.

Copy link
Member

@sunjayBhatia sunjayBhatia left a comment

Choose a reason for hiding this comment

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

the deploy preview looks great 👍🏽

looked through the commits as well, seems like you caught all the cross-page links

might be a good time to reenable or at least rerun the link checker for this change

Signed-off-by: Steve Kriss <krisss@vmware.com>
@skriss
Copy link
Member Author

skriss commented Jan 13, 2023

might be a good time to reenable or at least rerun the link checker for this change

Yeah didn't that break with the migration to Hugo? Will have to look and see if there's something we can use, agreed it would be a nice check to have.

@sunjayBhatia
Copy link
Member

might be a good time to reenable or at least rerun the link checker for this change

Yeah didn't that break with the migration to Hugo? Will have to look and see if there's something we can use, agreed it would be a nice check to have.

yep i think that was around the time it was disabled

@sunjayBhatia
Copy link
Member

sunjayBhatia commented Jan 13, 2023

might be a good time to reenable or at least rerun the link checker for this change

Yeah didn't that break with the migration to Hugo? Will have to look and see if there's something we can use, agreed it would be a nice check to have.

I'm cool with merging and doing another link check on the side and fixing things in another PR! (if there is anything to fix)

@skriss
Copy link
Member Author

skriss commented Jan 13, 2023

Sounds good, will merge and then find a link checker to use.

@skriss skriss merged commit 7a79163 into projectcontour:main Jan 13, 2023
@skriss skriss deleted the pr-versioned-guides branch January 13, 2023 19:36
yangyy93 pushed a commit to projectsesame/contour that referenced this pull request Feb 16, 2023
Closes projectcontour#4396.

Signed-off-by: Steve Kriss <krisss@vmware.com>
Signed-off-by: yy <yang.yang@daocloud.io>
yangyy93 pushed a commit to projectsesame/contour that referenced this pull request Feb 16, 2023
Closes projectcontour#4396.

Signed-off-by: Steve Kriss <krisss@vmware.com>
Signed-off-by: yy <yang.yang@daocloud.io>
vmw-yingy pushed a commit to vmw-yingy/contour that referenced this pull request Feb 28, 2023
Closes projectcontour#4396.

Signed-off-by: Steve Kriss <krisss@vmware.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note/docs A documentation change for the release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move non versioned Guide docs to versioned docs
2 participants