Update repo wiki page based on docs #3069
Open
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
Comment on lines
+12
to
+14
| USER_TOKEN: <USER_TOKEN_ENV_VARIABLE> # This is the repository secret | ||
| USER_NAME: <USER_NAME> # Enter the username of your (bot) account | ||
| USER_EMAIL: <USER_EMAIL> # Enter the e-mail of your (bot) account |
There was a problem hiding this comment.
Do these need to be filled out with anything?
There was a problem hiding this comment.
Yes they do, for the CI to run, there needs to be the environment variable for the user token secret, kind of like secrets.GITHUB_TOKEN that you have in release.yml workflow.
for the name and email, those are for the commits, so we can see in the wiki where the updates come from. It usually shows as "revisions".
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.
I tested this on my own fork. Whenever files in docs are changed and pushed to the desired branch (currently set to
main), the content ofdocs/*get all pushed to the repo's wiki. Making the wiki page update correctly.For this to work :
1- The wiki page must be enabled, by creating a first page (
Home.mdpage).2- Fill in the placeholders for user info and token in
wiki.ymlfor the CI to work properly.With this we can have a more readable docs in the wiki page of the repo, this can be linked from the website too until we support converting this markdown pages to static pages.