Add publish.sh to publish to NPM-JS and Github Pages. #429
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
eladb
reviewed
Jul 30, 2018
publish.sh
Outdated
| ) | ||
|
|
||
| git clone -b gh-pages --depth=1 ssh://github.com/awslabs/aws-cdk ${GIT_REPO} | ||
| rsync -ar --delete --exclude=/.git ${DOC_STAGING}/node_modules/aws-cdk-docs/dist/docs/ ${GIT_REPO}/ |
There was a problem hiding this comment.
We need to maintain docs for all versions so it will be possible to point to a specific version when referencing the docs. So I think we should publish the docs to a per-version directory (i.e. /v0.7.3-beta) and /also/ publish the latest docs to the root (or just generate an index.html at the root with a redirect metadata). Thoughts?
There was a problem hiding this comment.
Yeah - I've added code to copy the released doc both to the root and to a versions/${version-number} directory.
eladb
approved these changes
Jul 30, 2018
eladb
approved these changes
Jul 30, 2018
|
|
||
| const browserCommand = argv.browser.replace(/%u/g, documentationIndexPath); | ||
| const docVersion = require('../../package.json').version; | ||
| const browserCommand = argv.browser.replace(/%u/g, `https://awslabs.github.io/aws-cdk/versions/${docVersion}/`); |
There was a problem hiding this comment.
Can we opportunistically make someone happy?
There was a problem hiding this comment.
Yes - just added a change to make the URL extra-visible if we couldn't start the browser.
This was referenced Apr 24, 2023
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.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.