Skip to content

Commit

Permalink
docs: add example for Github Pages deployment; rewrite deployment sec…
Browse files Browse the repository at this point in the history
…tion (#4409)

* docs: Minor copy changes + increment numbered list

* docs: Add alternative github pages deploy workflow

* docs: Add separate PR workflow for alternative gh-pages deploy example

* docs: Minor `gh-pages` deploy config improvements

Improve some comments and clarifies the file path beyond file name alone for each config file.

Additionally removes the workflow path triggers as in practice these being updated shouldn't be triggering a re-run of the workflow again (assuming deterministic build from same input results in same output).

If there is a need for such a manual trigger of the workflow is probably a better approach. Performing a build because workflow comments were modified only would be pointless for example.

* docs: Clarify `gh-pages` deploy config some more

* chore: PR Feedback - Remove inline documentation

Upstream doesn't see value including help comments for a copy/paste config under the basis that it adds friction to the viewer seeking guidance how to perform something they don't know.

* chore: PR Feedback - Rephrase instruction

MatanBobi requested a rephrase during review.

* Rewrite

* Fixes

* Fix!

* Format

* Fix indentation

* Improvements

* Minor fixes

Co-authored-by: Josh-Cena <[email protected]>
  • Loading branch information
polarathene and Josh-Cena authored Nov 7, 2021
1 parent effa46e commit caa9d92
Showing 1 changed file with 274 additions and 180 deletions.
Loading

0 comments on commit caa9d92

Please sign in to comment.