build: Expand versioning process in readme #698
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
Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
farshidtz
commented
Feb 22, 2022
README.md
Outdated
| - `docs/CNAME` - DNS record which tells Github Pages to serve the content at https://docs.edgexfoundry.org instead of https://edgexfoundry.github.io/edgex-docs | ||
| - `docs/index.html` - site index page that redirects from `/` to `/{latest-release}` | ||
| - `docs/versions.json` - version info to populate the site version drop-down menu | ||
| - `versions.json` - identical to `docs/versions.json`. Unknown purpose! |
There was a problem hiding this comment.
@ernestojeda is the last file used by the Jenkins pipeline? If not, we can remove it.
There was a problem hiding this comment.
Jenkins does not use any of the files specifically that I know of. It just calls mkdocs and copies the generated files in the docs folder into the gh-pages branch.
There was a problem hiding this comment.
Okay. Since this is the case, I went ahead and removed that extra versions.json file.
ernestojeda
previously approved these changes
Feb 23, 2022
The reference version file is at docs/versions.json Signed-off-by: Farshid Tavakolizadeh <farshid.tavakolizadeh@canonical.com>
edgex-jenkins
added a commit
that referenced
this pull request
Feb 23, 2022
Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>
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.
Closes #680
Signed-off-by: Farshid Tavakolizadeh farshid.tavakolizadeh@canonical.com
If your build fails due to your commit message not passing the build checks, please review the guidelines here: https://github.com/edgexfoundry/edgex-docs/blob/main/.github/Contributing.md
PR Checklist
Please check if your PR fulfills the following requirements:
X Not relevant