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.

Sign up for GitHub

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

Jump to bottom

Implement version control for documentation #48

Open

NeethuES-intel opened this issue Feb 18, 2025 · 0 comments

Labels

Advanced CICD documentation enhancement

Contributor

NeethuES-intel commented Feb 18, 2025

Implement document versioning (can use Mike tool, but has issues. Check note below) for https://intel-retail.github.io/documentation/index.html
Automate document deployment using github action with gh-actions

References:
Mike tool - https://github.com/jimporter/mike
Setting up versioning with mike - https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/

Note:
Earlier, Mike tool was used to implement versioning. After automating the document deployment using github actions with gh-actions, latest version of the document is lost. Please refer to this earlier bug & PR -
intel-retail/automated-self-checkout#498
intel-retail/automated-self-checkout#504

Eg

NeethuES-intel added Advanced CICD documentation enhancement labels

NeethuES-intel added this to Automated Self Checkout Sprint Planning

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment