Skip to content

Commit

Permalink
Add contributing guide for the repository
Browse files Browse the repository at this point in the history
  • Loading branch information
oleg-nenashev committed Feb 25, 2024
1 parent c43ff46 commit dd73e13
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 2 deletions.
59 changes: 59 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Contributing to the Community Site

Contributing to this site is easy!
Just submit a pull request to the respective repository.
On the rop right corner you can also see the _Edit_ icons
that will normally get you right to the content page.

We do not have so many newcomer friendly issues in this repository,
but you are welcome to submit any small and big patches!

## Technology under the hood

The community site is built with [MkDocs](https://www.mkdocs.org/),
[MkDocs Multirepo Plugin](https://github.com/jdoiro3/mkdocs-multirepo-plugin/tree/main),
and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material).
So, it uses the Python technology stack instead of Gradle,
but on the other hand we're leveraging one of the most powerful documentation engines.

Requirements:

- Python3 and PiP (Python's package manager), recent versions
- Linux, MacOS or Windows WSL-2 environment.
Windows native may work but it is not tested.

## Preparing the environment

Soon we plan to provide a DevContainer to speedup the process.
For now, you need to install the dependencies:

```shell
pip install -r requirements.txt
mkdocs build
```

## Local development

Once you have the ready to build environment,
you can use `mkdocs build` to build the static site.

To do live development, use the following command to provision the site on `http://localhost:8000/community`:

```shell
mkdocs serve
```

Note that the Mkdocs Multi-Repo plugin is quite slow,
and it may take up to 10 seconds to rebuild the website on configuration changes.
If you develop the local part within this repository (design, content, etc.),
you can run the `build` and the `serve` commands with the `FULL_BUILD=false` variable, e.g.:

```shell
FULL_BUILD=false mkdocs serve
```

## CI/CD

This site is built and deployed by GitHub Actions.
We have continuous delivery, so your patches will be delivered just a few minutes
after the change is merged.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ All contributions are welcome!
See the [Contributing Guidelines](./contributing/README.md) for the links to specific resources and guidelines.

If you want to contribute anything to this `gradle/community` repository,
just submit a pull request.
see [this page](./CONTRIBUTING.md).
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ nav:
- Getting Started: contributing/README.md
- Contribute to Gradle Build Tool: gradle/CONTRIBUTING.md
- Contributing to GBT Docs: gradle/platforms/documentation/docs/README.md
- Contributing to the Community Site: CONTRIBUTING.md
- Reporting Vulnerabilities: dotgithub/SECURITY.md
- Code of Conduct: dotgithub/CODE_OF_CONDUCT.md
- Key Projects:
Expand Down Expand Up @@ -141,7 +142,7 @@ plugins:
# OpenGraphs
- social
- group:
enabled: true
enabled: !ENV [FULL_BUILD, true]
plugins:
- multirepo:
cleanup: false
Expand Down

0 comments on commit dd73e13

Please sign in to comment.