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

Directory and file naming conventions updated for style guide

Browse source
This commit is contained in:
hank L 2023-03-09 22:11:56 +00:00
commit a59074385d
1 changed files with 26 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

27
modules/ROOT/pages/contributing-docs/style-guide.adoc
View file

@ -1,6 +1,6 @@
= Fedora Documentation Style Guide
Fedora Documentation Team <https://discussion.fedoraproject.org/tag/docs>
2023-02-24
2023-03-09
[NOTE]
====
@ -108,6 +108,31 @@ If you’re only showing an application, use the default size of the app to scre
Upload and use that original media in your article:: If the shot is large, like a large browser window, app, or whole screen, choose a medium size thumbnail and let Antorra CMS handle the conversion.
=== Use of directory and file naming conventions
To follow distinct naming conventions consistently,
Retain the original title of article, use it on a subdirectory name and title of images.
The images go into the directory path like below:
~/modules/ROOT/assets/images/<ARTICLENAME_SHORTEND>/.png
.Naming subdirectory and files
[example]
The title on H1 heading is Finding and installing Linux applications. The file name is finding-installing-linux-apps.adoc. Create a subdirectory following paths in Quick Docs repo in Pagure: ~/modules/ROOT/assets/images/finding-installing-linux-apps/.png
Refer to the image in the text as:
image::finding-installing-linux-apps/gnome1-featured.png[]
=== Block image title
Define the title of the block image to display it underneath the image when rendered.
.GNOME Software
image::finding-installing-linux-apps/gnome1-featured.png[]
Run local preview script before commits and PR.
== Processing tips