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

[Enhancement] New build process of Docs Site through GitHub Actions and GitHub Pages #9062

Open
peterzhuamazon opened this issue Jan 14, 2025 · 3 comments
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. enhancement New feature or request

Comments

@peterzhuamazon
Copy link
Member

[Enhancement] New build process of Docs Site through GitHub Actions and GitHub Pages.

As part of the transition to OpenSearch Software Foundation, we will be more open on the site build and deployment process, and switch to github actions and github pages.

I am already doing a few tests and were able to bind multiple version sites into one deployment, pending PR. Thanks.

@peterzhuamazon
Copy link
Member Author

Able to get the first copy of latest deployed but apparently there are a lot of instances of docs/latest hardcoded in documentation-website code base.

Here are some of the examples:

<a role="treeitem"href="http://localhost:4000/docs/latest/automating-configurations/api/get-workflow/" class="nav-list-link" >Get a workflow</a>


Loading failed for the <script> with source "file:///docs/latest/assets/js/just-the-docs.js". index.html:1:654
Loading failed for the <script> with source "file:///docs/latest/assets/js/version-selector.js". index.html:1:2551
Loading failed for the <script> with source "file:///docs/latest/assets/js/search.js". index.html:1:52383
Loading failed for the <script> with source "file:///docs/latest/assets/js/home-listener.js". index.html:1:52447



./_includes/redesign_buttons.html:            <a href="https://opensearch.org/docs/latest/" class="redesign-button--anchor" id="documentation-button">
./_includes/redesign_buttons.html:            <a href="https://opensearch.org/docs/latest/" class="redesign-button--anchor" id="documentation-button">
./_includes/cards.html:      <a href="{{site.url}}/docs/latest/data-prepper/" class='card-link'></a>
./_includes/cards.html:      <a href="{{site.url}}/docs/latest/clients/" class='card-link'></a>
./_includes/cards.html:      <a href="{{site.url}}/docs/latest/benchmark/" class='card-link'></a>
./_includes/cards.html:      <a href="{{site.url}}/docs/latest/migration-assistant/" class='card-link'></a>
./_includes/head_custom.html:  <script src="{{ '/docs/latest/assets/js/version-selector.js' }}"></script>
./_about/index.md:  - /docs/opensearch/
./_about/index.md:{%- comment -%}The `/docs/opensearch/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}

Have an offline conversation with @kolchfa-aws and she will take a look on those.

This would be the a step closer towards changes from /docs/latest to /latest as part of the LF transition on the docs website.

Thanks.

@peterzhuamazon
Copy link
Member Author

peterzhuamazon commented Jan 17, 2025

Able to have a chain of simple github actions triggered solely by push event.

Each push on corresponding branches will just change the corresponding folder on the deployment directory.

https://docsstaging.opensearch.net/docs/latest/

As of now only 1.3, 2.17, 2.18/latest version switches are deployed as a POC to showcase the usages.

Will add more updates as well as potential version check.

Thanks.

@Naarcha-AWS Naarcha-AWS added the 2 - In progress Issue/PR: The issue or PR is in progress. label Jan 17, 2025
@peterzhuamazon
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. enhancement New feature or request
Projects
Status: 🏗 In progress
Status: In Progress
Development

No branches or pull requests

2 participants