[docs] update docs.yml and docs workflow to support versioning #3365
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
frankfliu
reviewed
Jul 26, 2024
frankfliu
force-pushed
the
master
branch
2 times, most recently
from
4e9c6bf
to
0023085
Compare
frankfliu
reviewed
Aug 1, 2024
.github/workflows/docs.yml
Outdated
| - name: Configure Deployment AWS Credentials | ||
| uses: aws-actions/configure-aws-credentials@v4 | ||
| with: | ||
| aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} | ||
| aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | ||
| aws-region: us-east-2 | ||
|
|
||
| - name: Build docs website | ||
| run: tools/scripts/build-website.sh "${{ github.event.inputs.version-number || 'master' }}" |
There was a problem hiding this comment.
build-website doesn't need aws credentials, why move to here?
There was a problem hiding this comment.
I am working on section in build-website that would download the previous versions.json and then prepend the new version info to it. I moved the aws credentials up to download the versions.json file
frankfliu
reviewed
Aug 1, 2024
tools/scripts/build-website.sh
Outdated
| git checkout gh-pages | ||
|
|
||
| echo "Attempting to update versions.json" | ||
| aws s3 cp s3://djl-ai/documentation/nightly/versions.json . |
There was a problem hiding this comment.
- Can we just generate this
versions.jsonfile without download it? - We don't need use awscli to download it, we can use curl:
curl -O https://docs.djl.ai/versions.json
There was a problem hiding this comment.
Probably, I'll look into using curl, I am unfamiliar with it
Varun-Dutta
changed the title
frankfliu
approved these changes
Aug 3, 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.
Chages to mkdocs.yml
Changes to docs workflow
Changes to build-website.sh
Testing:
TODO