Skip to content

Commit

Permalink
Adding the contributing guide (#43)
Browse files Browse the repository at this point in the history
* adding contributing guide
  • Loading branch information
missmesss authored Jun 7, 2024
1 parent 21d30e0 commit f692b92
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 10 deletions.
38 changes: 28 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Konflux-CI Documentation Contributing Guide
# Konflux-CI documentation contributing guide

AsciiDoc is a plain text documentation syntax, also known as a mark-up
language, for text files. AsciiDoc is rendered as HTML automatically by
web browsers, so the files can be viewed as formatted text via the GitLab
repository URL.

## Development
## Contributing

For active maintenance/development of the documentation, developers
should create a
Expand All @@ -18,7 +13,14 @@ specific branches in their forked repositories, but merge request should
always target the default branch of the
[Konflux repository](https://github.com/konflux-ci/docs).

### Rendering Individual Pages
## Working with AsciiDoc

The Konflux documentation is developed in AsciiDoc format. AsciiDoc is a plain text documentation syntax, also known as a mark-up
language, for text files. AsciiDoc is rendered as HTML automatically by
web browsers, so the files can be viewed as formatted text via the GitLab
repository URL.

### Rendering individual pages

To render individual AsciiDoc pages for review,
use the `asciidoctor` software to generate HTML files.
Expand All @@ -45,7 +47,7 @@ for information on enabling AsciiDoc rendering.
> below to render the entire site for a final check of any changes to the
> documentation.
### Rendering the Entire Site
### Rendering the entire site

To locally render the entire site, navigate to the root of the repository
and run:
Expand All @@ -71,7 +73,23 @@ python -m pip install watchdog[watchmedo]
watchmedo auto-restart --patterns="*.adoc" --recursive npm run dev
```

## AsciiDoc Mark-Up Language References
### Converting Markdown to AsciiDoc

If you prefer to work with Markdown, you can convert your Markdown files into AsciiDoc using any conversion tool, for example Pandoc:

1. Install [Pandoc](https://pandoc.org/installing.html)

2. Convert a file by running the following command:

```bash
pandoc [file name].md -f markdown -t asciidoc [file name].adoc
```

The `-f` option specifies the input format, and the `-t` option specifies the output format. For more options, see [General options](https://pandoc.org/chunkedhtml-demo/3.1-general-options.html) for the `pandoc` command.

3. Render the resulting AsciiDoc file using the Integrated Development Environment (IDE) of your choice, the `asciidoctor` text processor, or any other option.

### AsciiDoc mark-up language references

The [AsciiDoc Writer's Guide](https://asciidoctor.org/docs/asciidoc-writers-guide/)
"provides a gentle introduction to AsciiDoc".
Expand Down
15 changes: 15 additions & 0 deletions docs/modules/ROOT/pages/contribute/index.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
= Contribute to {ProductName}

To contribute to this documentation:

. Select *Edit this Page* in the banner on any page. This action takes you to the link:https://github.com/konflux-ci/docs[source docs on GitHub] and opens a web editor, where you can propose specific changes.

+
NOTE: When suggesting changes, use the AsciiDoc syntax because that's what we use when writing the Konflux-CI documentation.

. When you finish editing in GitHub, select *Create a new branch for this commit and start a pull request*.

. Name your pull request and select *Propose changes*.

NOTE: You can also choose to fork the link:https://github.com/konflux-ci/docs[Konflux-CI/docs repository] on GitHub and edit documentation locally on your machine. For contribution guidelines and AsciiDoc help, see the link:https://github.com/konflux-ci/docs/blob/main/CONTRIBUTING.md[Konflux-CI docs contributing guide].

We appreciate any edits that you suggest!

0 comments on commit f692b92

Please sign in to comment.