This repository has been archived by the owner on May 12, 2021. It is now read-only.
Added updating documentation to release process #42
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
|
|
||
| The documentation will be generated as static HTML files and copied into the ```apex-site``` repository. It will be available at an alternate URL location until the release is promoted, at which time it will also be promoted to the main website location. | ||
|
|
||
| Do the following setup setups before building and deploying the documentation. Clone the apex-site repository into a folder called ```apex-site``` at the same level as the current repository. Set the following environment variables |
pramodin
force-pushed
the
documentation-in-release
branch
from
57b3f97
to
518e0aa
Compare
pramodin
force-pushed
the
documentation-in-release
branch
from
518e0aa
to
32fc0f0
Compare
| @@ -201,6 +252,27 @@ git push apache | |||
| ``` | |||
| Merge `@since` tag and change log changes to `master`. | |||
|
|
|||
| ### Documentation | |||
|
|
|||
| The documentation promotion is done in two steps. First the release documentation component is made available on the website and then the remaining website documentation is deployed. | |||
There was a problem hiding this comment.
This sentence is confusing. Maybe just remove it?
There was a problem hiding this comment.
I will reword it. The intent is to say that the module documentation is first deployed then the rest of the website is deployed.
|
@tweise made the changes |
|
Please see remaining comment and then squash. This is ready to go live. |
pramodin
force-pushed
the
documentation-in-release
branch
from
d69d464
to
563cda8
Compare
|
Updated and squashed. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I had some updates to docs and had noticed that we don't include building and staging documentation as part of the release process even though all the steps for it is already present in other places.
Including steps to build and stage documentation as part of the release process just like we do for source code. These have been taken from existing documentation in other places and adapted accordingly. @sashadt and @tweise please review.