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

Legacy gateway documentation preview #3877

Closed
wants to merge 15 commits into from

Conversation

lena-larionova
Copy link
Contributor

@lena-larionova lena-larionova commented Apr 22, 2022

DO NOT MERGE DO NOT MERGE DO NOT MERGE

This branch is for generating a Netlify preview only.
Because of this, please review the preview only and don't bother looking at the 3000+ changed files.

I've removed most of the doc content from this branch and left only the Gateway version that are already archived or will be with 3.0.

https://legacy-gateway--kongdocs.netlify.app/

@lena-larionova lena-larionova added do not merge Issues/ PRs whose changes should not be merged at this time review:tech Request for technical review on the docs platform or processes. review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? labels Apr 22, 2022
@lena-larionova lena-larionova requested a review from a team as a code owner April 22, 2022 21:07
@lena-larionova lena-larionova marked this pull request as draft April 22, 2022 21:09
@netlify
Copy link

netlify bot commented Apr 22, 2022

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 7dffa31
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/62703b0bb4c1000008796a75
😎 Deploy Preview https://deploy-preview-3877--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@Guaris
Copy link
Contributor

Guaris commented Apr 25, 2022

What if we removed everything under the <hr> tag in this menu, and just left these three options? I also added the [archive] there as an attempt to try to make it very clear what the reader is looking at. Let me know what you think. If you like it, let me know and I can make a commit. Otherwise, everything looks good.
Screen Shot 2022-04-25 at 11 24 54 AM

@lena-larionova
Copy link
Contributor Author

Thanks for calling that out, because I meant to ask for feedback on exactly that 😄 I used the option you suggest for the dropdown, to show the two different approaches:

Screen Shot 2022-04-25 at 8 41 52 AM
(https://deploy-preview-3877--kongdocs.netlify.app/enterprise/1.5.x/)

I agree with you that having the short list makes it more clear that this is an archive. The other thing I was thinking of is adding a banner across the whole site, calling out that this is an archive, to really drive the point home.

@Guaris
Copy link
Contributor

Guaris commented Apr 26, 2022

Small copy suggestion on the banner
Current:
You are browsing documentation for an outdated version. The latest Kong Gateway documentation is now available as a combined doc set for Kong Gateway Enterprise and open-source (OSS).

Potential:
You are currently viewing legacy documentation. Go to the latest

or

This documentation is no longer actively maintained. Go to the latest

let me know what you think.

@lena-larionova
Copy link
Contributor Author

lena-larionova commented Apr 26, 2022

Small copy suggestion on the banner Current: You are browsing documentation for an outdated version. The latest Kong Gateway documentation is now available as a combined doc set for Kong Gateway Enterprise and open-source (OSS).

Potential: You are currently viewing legacy documentation. Go to the latest

or

This documentation is no longer actively maintained. Go to the latest

let me know what you think.

That suggestion works.

I actually haven't added a banner for the archive yet, that's one that exists on all of our versioned docs 😄 .
Check any version that isn't "latest". eg: https://docs.konghq.com/gateway/2.7.x/
And the slight difference for the old split versions of Gateway docs: https://docs.konghq.com/enterprise/2.5.x/

For the archive banner, I want something more prominent/obvious than that one (visually, that is).

@mheap
Copy link
Member

mheap commented Apr 29, 2022

Once this is ready we should close the PR and create a branch preview on Netlify (like we did for Konnect) rather than using the PR preview.

Is it just the main banner outstanding?

@lena-larionova
Copy link
Contributor Author

Once this is ready we should close the PR and create a branch preview on Netlify (like we did for Konnect) rather than using the PR preview.

Is it just the main banner outstanding?

It's just the banner now, I'll do that today. Agree that we should close this PR then (especially since rebasing/merging to update this PR is extremely painful; any change to a "deleted" file causes a conflict, so it's not feasible to keep updating).

I have a branch preview up at https://legacy-gateway--kongdocs.netlify.app now.

@lena-larionova
Copy link
Contributor Author

Closing, this PR was only ever meant for generating a preview.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge Issues/ PRs whose changes should not be merged at this time review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:tech Request for technical review on the docs platform or processes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants