Enhanced README: Contribution Guidelines, TOC, and Overview #2504
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,21 +1,51 @@ | ||||||
| ## Matrix.org Website | ||||||
|
|
||||||
| # Table of Contents | ||||||
| - [Overview](#overview) | ||||||
| - [Building the Website](#building-the-website) | ||||||
| - [Contribution Guidelines](#contribution-guidelines) | ||||||
| - [Contact Us](#contact-us) | ||||||
|
|
||||||
| # Overview | ||||||
|
|
||||||
| Matrix.org is a decentralized, open standard for real-time communication which allows users to collaborate in public and private rooms over IP. Matrix's purpose is to allow users to text and call without thinking about what app or phone the other user has. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| ## Building the website | ||||||
| To contribute or run the website locally, follow the instructions below: | ||||||
| 1. ''' | ||||||
| git clone https://github.com/matrix-org/matrix.org.git | ||||||
| cd matrix.org | ||||||
|
Comment on lines
+17
to
+19
There was a problem hiding this comment. This seems to not be working with Github Markdown. Could you fix that please? Have a look at the rich diff button on the top right of this file to see how it is being rendered |
||||||
| ''' | ||||||
| 2. Ensure Zola is installed, otherwise install the latest version of [Zola](https://www.getzola.org) | ||||||
| From the root repo run the following command | ||||||
| ``` | ||||||
| zola serve | ||||||
| ``` | ||||||
|
|
||||||
| Zola will build the website and start a web server, usually at | ||||||
| http://127.0.0.1:1111 | ||||||
|
|
||||||
| 3. To build the website for production, run the command: | ||||||
| ''' | ||||||
| zola build | ||||||
| ''' | ||||||
|
Comment on lines
+31
to
+33
There was a problem hiding this comment. Same as the other comment |
||||||
|
|
||||||
| ## Contribution Guidelines | ||||||
| 1. Fork the reposity (https://github.com/matrix-org/matrix.org.git) | ||||||
| 2. Clone your fork to your local computer | ||||||
| 3. Create a new branch and implement changes using | ||||||
| ''' | ||||||
| git checkout -b <yourBranchName> | ||||||
|
Comment on lines
+39
to
+40
There was a problem hiding this comment. Same as the other comment |
||||||
| 4. Submit a pull request (PR) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
|
|
||||||
| # Contact Us | ||||||
|
|
||||||
| ## Community | ||||||
| If you have any questions about the project or your contribution, you may join the various community chats on https://matrix.to/#/#matrix.org-website:matrix.org | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Before contributing, make sure the feature or bug you intend to address has already been discussed in our issue tracker | ||||||
| and that we are interested in reviewing and merging such a contribution. | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.