egret/team-docs
1
0
Fork 1
forked from docs/team-docs
Code Pull requests Wiki Activity

docsbuild script updated

Browse source
This commit is contained in:
hank L 2023-03-18 12:24:29 +00:00
commit fd2b556049
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
modules/ROOT/pages/contributing-docs/tools-localenv-preview.adoc
View file

@ -1,6 +1,6 @@
= Building a local preview
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
:revdate: 2023-03-12
:revdate: 2023-03-18
[abstract]
A local preview is a valuable tool to test your changes when working on your local authoring environment. Run shell scripts available in Fedora content repository: `build.sh` and `preview.sh`. You can build and run the fully rendered site on your machine to preview your changes before making a pull request to the Fedora content repositories. Some Fedora content repositories have the builder.sh script that you can use in lieu of the build.sh and preview.sh scripts.
@ -23,17 +23,19 @@ you need build scripts to render the changes predictably and test them before yo
== What the scripts do
The build.sh script is the one that actually builds a local version of the site, which means the subset of the full site that resides in your local repository. The preview.sh script starts a webserver and serves the site at link:http://localhost:8080/[]. Opening this link in any web browser will show you the preview, which will be available until you kill the process (kbd:[Ctrl+C] in the terminal).
A unified docs builder script, docsbuilder.sh, builds a local version of the site, which means the subset of the full site that resides in your local repository. In turn, the script starts a webserver and serves the site at link:http://localhost:8080/[]. Opening this link in any web browser will show you the preview, which will be available until you kill the process (kbd:[Ctrl+C] in the terminal).
Check README.md on the landing page of projects to run the script suggested to use.
=== How to test changes
Go to the the directory where cloned repo is, build, watch and preview the site by running the build scripts in terminal.
----
$ ./build.sh && ./preview.sh
$ ./docsbuilder.sh
----
Pagure or other content repositories display a different builder script. Check README.md on the landing page of projects and run the script suggested to use.
Pagure or other content repositories display a different builder script.
----
$ ./builder.sh