Skip to content

Refactor URLs in includes #9867

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

Merged
merged 2 commits into from
May 13, 2025
Merged

Refactor URLs in includes #9867

merged 2 commits into from
May 13, 2025

Conversation

kolchfa-aws
Copy link
Collaborator

@kolchfa-aws kolchfa-aws commented May 7, 2025

This PR:

  • Fixes top nav links pointing to main OpenSearch site
  • Adds a variable for the latest doc URL (so the non-versioned documentation can refer to that)
  • Makes links in yaml files full links
  • Aligns the top nav with the project website's
  • Deletes unused redesign buttons
  • Uses variables in includes rather than hard-coded links

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Copy link

github-actions bot commented May 7, 2025

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@@ -9,7 +9,7 @@
{% if jekyll.environment == "development" %}
<script src="{{ '/assets/js/version-selector.js' | relative_url }}"></script>
{% else %}
<script src="{{ '/docs/latest/assets/js/version-selector.js' }}"></script>
<script src="{{site.baseurl}}/assets/js/version-selector.js"></script>
Copy link
Member

Choose a reason for hiding this comment

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

Seems like we are replacing hardcode /docs/latest in version selector with {{site.baseurl}}. But this doesn't change the path or routing from before.
Are we plan to update the baseurl in the future so eventually the URL pattern would be docs.opensearch.org/latest/...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, we're just extracting the path into a variable so when we change the url, we can change only the variable in the _config.yml file (and whatever links are hardcoded in the yaml files).

Copy link
Member

@zelinh zelinh left a comment

Choose a reason for hiding this comment

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

LGTM.

@zelinh
Copy link
Member

zelinh commented May 12, 2025

You may need to rebase to resolve the conflict.

Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
@kolchfa-aws kolchfa-aws merged commit e45b796 into main May 13, 2025
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 13, 2025
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
(cherry picked from commit e45b796)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
github-actions bot pushed a commit that referenced this pull request May 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants