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

[docs] Move OPA ecosystem pages to site top-level #6198

Merged
merged 7 commits into from Aug 31, 2023

Conversation

charlieegan3
Copy link
Contributor

@charlieegan3 charlieegan3 commented Aug 30, 2023

Why the changes in this PR are needed?

  • We are having trouble managing the complexity of having ecosystem pages shown in the versioned area of the OPA docs site (see website: link ecosystem from edge #6170)
  • We have invested in the OPA ecosystem data recently and it makes sense to make it more prominent.
  • The data in the OPA Ecosystem is harder to use when nested in docs as some Hugo functions are unavailable to nested sections.

What are the changes in this PR?

Pages that were under /docs/version/ecosystem, /docs/version/integrations etc have been moved to /ecosystem and /integrations. Redirects have been created for the old pages in the netlify config.

Test the redirects

All these links:

Should redirect correctly.

Does this need to be in before the next release?

It’s not required that this is in before the next release as it’s only the contents of docs/content which is versioned with releases.

This moves a load of content out of that directory into docs/website/content which is applied immediately.

That said, I see no reason we shouldn’t try and get it in ASAP because the latest: https://www.openpolicyagent.org/docs/latest/ecosystem/ is still incorrect.

@netlify
Copy link

netlify bot commented Aug 30, 2023

Deploy Preview for openpolicyagent ready!

Name Link
🔨 Latest commit 9b0cec0
🔍 Latest deploy log https://app.netlify.com/sites/openpolicyagent/deploys/64ef3a14d02a270008f0e6bf
😎 Deploy Preview https://deploy-preview-6198--openpolicyagent.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 configuration.

@netlify
Copy link

netlify bot commented Aug 30, 2023

Deploy Preview for openpolicyagent ready!

Name Link
🔨 Latest commit e818cb5
🔍 Latest deploy log https://app.netlify.com/sites/openpolicyagent/deploys/64ef4b065f79f60007a4c46f
😎 Deploy Preview https://deploy-preview-6198--openpolicyagent.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 configuration.

@charlieegan3 charlieegan3 changed the title Ecosystem eject [docs] Move OPA ecosystem pages to site top-level Aug 30, 2023
@charlieegan3 charlieegan3 marked this pull request as ready for review August 30, 2023 13:40
Copy link
Contributor

@philipaconrad philipaconrad left a comment

Choose a reason for hiding this comment

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

@charlieegan3 This looks excellent! Thanks for looking into a better way to organize the unwieldy number of ecosystem items that have accrued over time. 🙂

On the code side, I'm not seeing anything too unexpected-- there's a big change of templates, which I'd expect for a UI change this dramatic + a lot of small repetitive edits to pull all the old content into the new structure.

Overall, looks great! 👍

Copy link
Member

@ashutosh-narkar ashutosh-narkar left a comment

Choose a reason for hiding this comment

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

The changes lgtm. The new look is great! Decoupling this from the versioned docs is a nice touch.

Signed-off-by: Charlie Egan <charlie@styra.com>
Signed-off-by: Charlie Egan <charlie@styra.com>
Signed-off-by: Charlie Egan <charlie@styra.com>
Signed-off-by: Charlie Egan <charlie@styra.com>
Signed-off-by: Charlie Egan <charlie@styra.com>
Signed-off-by: Charlie Egan <charlie@styra.com>
This is now handled with redirects

Signed-off-by: Charlie Egan <charlie@styra.com>
@srenatus
Copy link
Contributor

This is so nice. I kind of want to press "Integrations" here
image

but I can resist, just barely 😅

@charlieegan3
Copy link
Contributor Author

I kind of want to press "Integrations" here

Yeah, I can see that it's a little awkward in the breadcrumbs. But the listing of the integrations is on the /ecosystem page too - and has always been there. Perhaps we can change that around and make /integrations the main list in the future but will keep that for another PR.

@charlieegan3 charlieegan3 merged commit 9bf5478 into open-policy-agent:main Aug 31, 2023
25 checks passed
@charlieegan3 charlieegan3 deleted the ecosystem-eject branch August 31, 2023 08:36
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.

None yet

4 participants