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

Signed-off-by: Hanku Lee <allegrovelo@gmail.com>

Browse source 
Index page updated about local writing environment.
This commit is contained in:
hank L 2023-03-11 10:20:47 +00:00
commit ecfe0c65be
No known key found for this signature in database
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
modules/ROOT/pages/contributing-docs/index.adoc
View file

@ -54,8 +54,8 @@ The easy way – Use the GitLab web IDE::
Most of the steps are automatic. Suitable for editing existing articles as well as new ones.
The advanced way – Create a local writing environment::
Work with multiple files and repos offline at your pace using your choice of text editor and terminal
Work with multiple files and repos offline at your pace using your choice of text editor and terminal.
You can build and render the pages locally to test your changes using Podman container.
== Typical ways to contribute
@ -69,13 +69,13 @@ This typically involves minor changes, e.g., typo fixes, adding short informatio
The _File Edit tools_ are convenient for this purpose.
This is specifically true for _casual contributions_ when a user detects outdated or otherwise inaccurate information.
This is specifically true for _casual contributions_ when a user detects outdated or inaccurate information.
=== Extend an existing documentation domain
This typically involves adding one of more new chapter or section(s) with several chapters, e.g., adding another container technique to the documentation of containerization.
The _Web interface_ is a convenient tools for this purpose. A local writing environment is useable as well, but may involve too much overhead, if you want contribute to just one documentation.
The _Web interface_ is a convenient tool for this purpose. A local writing environment is useable as well, but may involve too much overhead, if you want contribute to just one documentation.
It is highly recommended to present the plan on one of the Docs communication channels before starting. You may get suggestions and tips on content, but also on editing, e.g., file structure and naming conventions.