docs: implement versioning documentation #10
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Coverage report
Test suite run success41 tests passing in 10 suites. Report generated by 🧪jest coverage report action from 7295d0c |
namhoang1604
approved these changes
Dec 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR implements versioning for the Storage Service documentation. It includes a pipeline to deploy the new version to GitHub Pages for the Storage Service documentation site.
Additionally, it captures the current documentation as version 1.0.0 and removes some unnecessary code in the AWS S3 adapter (
src/services/storage/aws.ts).What type of PR is this? (check all applicable)
Related Tickets & Documents
https://github.com/gs-gs/fa-ag-trace/issues/860
Mobile & Desktop Screenshots/Recordings
Trigger the deployment to GitHub Pages using the
build_publish_docs.ymlpipeline:Output testing domain:
https://huynguyen-hl.github.io/project-identity-resolver/ (will be replaced by https://uncefact.github.io/project-identity-resolver/)
Home Page:
Version: 1.0.1:
Version 1.0.0:
Added tests?
Added to documentation?
[optional] Are there any post-deployment tasks we need to perform?
[optional] What gif best describes this PR or how it makes you feel?