Add GitHub Actions and custom dir sections to Publish doc page #160
Conversation
matyasjay
changed the title
website/docs/Publishing.md
Outdated
| ## Custom build directory | ||
|
|
||
| You can set a custom build directory instead of the default `build` if needed by passing the `--out-dir` argument to `moonwave build` command. |
There was a problem hiding this comment.
I think it would make more sense to mention the --out-dir flag briefly here instead of creating a new section for it. Just something saying, "Or you can specify --out-dir [path] to set the build directory to a different path"
website/docs/Publishing.md
Outdated
| @@ -13,6 +13,21 @@ If you are using git and Github pages, you can publish your doc website with one | |||
|
|
|||
| Otherwise, you can run `moonwave build`, and your built website will be in a folder called `build` in your project directory. | |||
|
|
|||
| ## Using GitHub Actions | |||
|
|
|||
| When you publish your doc via GitHub Actions you might need to provide the author details and GitHub token. | |||
There was a problem hiding this comment.
You don't actually need to provide your own email and username, you can just provide the GitHub Actions username and email, github-actions-bot and [email protected].
There was a problem hiding this comment.
Yeah maybe you're right. I assumed the same (usually works fine with mock bot address) but got "Failed to get the author data" errors. Maybe it was just me and by default the workflow is just fine with mock author data.
website/docs/Publishing.md
Outdated
| When you publish your doc via GitHub Actions you might need to provide the author details and GitHub token. | ||
|
|
||
| ```yaml | ||
| - name: Publish |
There was a problem hiding this comment.
I would include the full example of a Moonwave GitHub Action, and move it down on the page since it has low importance. It's nice to include a working example of things to prevent confusion, we can also specify where they should put this in their repository in the description for this section.
|
I left some suggestions, not strictly necessary but would improve on the work you've started. Feel free to update the PR with the suggestions in mind- or don't. Thanks for your contributions. |
|
Hey @YetAnotherClown, thanks for the quick feedback! I made the changes accordingly, all makes sense to me. |
I guess it is a good idea to have these in the docs for future reference.