local-workflow-update #58

Merged
pbokoc merged 10 commits from egret/team-docs:local-docscontrib into main 2026-05-30 10:52:13 +00:00
2 changed files with 8 additions and 3 deletions
Showing only changes of commit a969a9862c - Show all commits

local-error-fix

Eli Ridge 2026-04-26 00:48:07 +12:00

View file

@ -19,8 +19,13 @@
*** xref:contributing-docs/tools-local-authoring-env.adoc[How to create and use a local Fedora authoring environment]
*** xref:contributing-docs/tools-localenv-preview.adoc[How to run a local preview]
*** xref:contributing-docs/tools-vale-linter.adoc[How to check documentation style with Vale]
<<<<<<< Updated upstream
*** xref:contributing-docs/tools-file-edit-forge.adoc[Edit a single page in Forge]
*** xref:contributing-docs/tools-edit-local-clone.adoc[Edit locally]
=======
*** xref:contributing-docs/tools-page-edit-forge.adoc[Edit a single page in Forge]
>>>>>>> Stashed changes
** xref:contributing-docs/style-guide.adoc[The docs style guide]
** xref:contributing-docs/asciidoc-intro.adoc[AsciiDoc for Fedora]

View file

@ -100,7 +100,7 @@ username@device:~/fedora-docs/name-of-project
* .adoc file contents window.
The above layout allows you to quickly select files, make edits, and issue git and preview commands, all within the same tool for convenience.
The above layout allows you to quickly select files, make edits, and issue git and preview commands, all within the same tool.
== Preview your work
@ -120,8 +120,8 @@ There is no requirement to install Antora or any other web development tools on
. In a browser, visit http://localhost:8080.
. To update the preview after further edits:
.. Ensure the script is at rest - the terminal window activity should have stopped and the last sentence read _Watching current directory_.
.. Save the .adoc file you have been editing and observe the script completes again.
.. Ensure the script is at rest - the terminal window activity should have stopped and the last sentence read _Watching current directory..._.
.. Save the .adoc file you have been editing and observe the script complete again.
.. Refresh the browser window.
== Pushing your changes to your remote fork in Forge