docs/team-docs
19
4
Fork 9
Code Issues 6 Pull requests 1 Projects Activity Actions

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
Conversation 13 Commits 10 Files changed 4 +9 -14
1 changed files with 9 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 155166ab46 - Show all commits

local-changes

Prev Next
Eli Ridge 2026-04-27 00:18:14 +12:00
commit 155166ab46

23
modules/ROOT/pages/contributing-docs/tools-edit-local-clone.adoc
View file

@ -91,11 +91,7 @@ Consider making use of the https://docs.fedoraproject.org/en-US/fedora-docs/cont
Configure your text editor or IDE of choice with the following three viewing windows:
* project folder structure.
* project terminal window open at
+
----
username@device:~/fedora-docs/name-of-project
----
* project terminal window open at `username@device:~/fedora-docs/name-of-project`.
* .adoc file contents window.
@ -109,8 +105,7 @@ The above layout allows you to quickly select files, make edits, and issue git a
----
./docsbuilder.sh
----
+
[EXPLANATION]
====
The ./docsbuilder script starts the Antora static site generator locally on your device within an isolated container.
@ -120,34 +115,34 @@ 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..._.
.. 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
1. Add the changes to your local git staging ground
1. Add the changes to your local git staging ground:
+
----
git add .
----
2. Commit with a message
2. Commit with a message:
+
----
git commit -m <meaningful-name-reflecting-what-you-changed>
----
3. Push your changes
3. Push your changes:
+
----
git push origin <branch-name>
----
You are now ready to open a pull request
You are now ready to open a pull request.
== Checklist
* [ ] Checked for spelling and grammatical errors
== PR Checklist
* [ ] Spelling and grammar checked.
* [ ] Metadata and author tags entered.