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

xref update on local preview

Browse source
This commit is contained in:
hank L 2023-03-19 15:50:07 +00:00
commit 1dfa328496
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
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-18
:revdate: 2023-03-19
[abstract]
A local preview is a valuable tool to test your changes when working on your local authoring environment. Run the docsbuilder script available in Fedora content repository. 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.
@ -10,6 +10,7 @@ A local preview is a valuable tool to test your changes when working on your loc
When working with local authoring environment, a local preview provides versatile workflow to test how the changes will be rendered and function in your browser locally. When you make changes such as, but not limited to;
- Change links or fix broken links
- Change document to document cross references using xref
- Consolidate multiple pages into one page
- Update images or fix broken images
- Add metadata or alt text for images