Skip to content

Commit de1187d

Browse files
authored
Adding docs page about contributing to orchardcore.net (#18612)
* Safer install instructions for the docs * Adding docs page about contributing to orchardcore.net
1 parent 2964b3c commit de1187d

File tree

4 files changed

+22
-1
lines changed

4 files changed

+22
-1
lines changed

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,7 @@ nav:
333333
- Contributing documentation: contributing/contributing-documentation.md
334334
- Reviewing pull requests: contributing/reviewing-pull-requests.md
335335
- Benchmarking: contributing/benchmarking.md
336+
- Contributing to orchardcore.net: contributing/contributing-to-orchardcore-net.md
336337
- Developer Meetings: contributing/meetings.md
337338
- Community:
338339
- Contributors: community/contributors/README.md

src/docs/contributing/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ One of the easiest ways to contribute is to participate in discussions under [Gi
1111
- [Contributing documentation](contributing-documentation.md)
1212
- [Reviewing pull requests](reviewing-pull-requests.md)
1313
- [Benchmarking](benchmarking.md)
14+
- [Contributing to orchardcore.net](contributing-to-orchardcore-net.md)
1415

1516
## Contributor License Agreement
1617

src/docs/contributing/contributing-documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ With MkDocs you can get the full docs.orchardcore.net experience locally too. If
3535

3636
1. Follow the [MkDocs installation guide](https://www.mkdocs.org/user-guide/installation/) to install Python, PIP and MkDocs. If you already have a fresh enough Python installation, you can simply run `pip install mkdocs`.
3737
2. Open a command line in the root of your clone of the repository.
38-
3. Run `pip install -r src/docs/requirements.txt` to install dependencies.
38+
3. Run `python -m pip install -r src/docs/requirements.txt` to install dependencies.
3939
4. Run `python -m mkdocs serve` to start the site. You'll then be able to browse it under <http://127.0.0.1:8000>.
4040

4141
## Submitting a pull request and gathering feedback
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Contributing orchardcore.net
2+
3+
Did you know that Orchard Core's official website, [orchardcore.net](https://orchardcore.net), is also an open-source project? And, of course, it's built using Orchard Core itself!
4+
5+
## How to start
6+
7+
To start, just clone the [Orchard Core Website repository](https://github.com/OrchardCMS/OrchardCore.Website). Instructions on working with the app are available in its Readme. Happy coding!
8+
9+
10+
!!! tip
11+
Contributing to orchardcore.net is a great way to get familiar with Orchard Core development on a real-life application, which is online and accessible to everyone already. If you're new to Orchard Core, consider starting here before diving into the main Orchard Core repository.
12+
13+
## What can you contribute?
14+
15+
First, check out the [issues](https://github.com/OrchardCMS/OrchardCore.Website/issues), but you can suggest content and technical improvements as well in the issue tracker.
16+
17+
## Need help?
18+
19+
Feel free to ask questions under the repository's issues, or in the `#🌐┃orchardcore-net` channel on [our Discord server](https://orchardcore.net/discord).

0 commit comments

Comments
 (0)