Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Contribution Guide on README.md #438

Merged
merged 7 commits into from
Oct 20, 2021
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,21 @@ Clone/download source code from the GitHub. Make sure you have _node_ and _npm_
1. snapcraft login
2. snapcraft upload Gaucho_0.6.0_amd64.snap --release=stable

### Contributing to Docs:
Gaucho Docs can be found at <https://angrykoala.github.io/gaucho/>.They have been built using [Docusaurus](https://docusaurus.io/).
#### Instructions:
> The docs branch is [/docs][docsurl].
adnanqazii marked this conversation as resolved.
Show resolved Hide resolved
* Commands for Development:
adnanqazii marked this conversation as resolved.
Show resolved Hide resolved
* `npm install` to install dependencies for project.
* `npm start` start to run docusaurus locally in port 3000

* Folders:
* /docs: Docs pages corresponding to items in menu(introduction,getting started etc) on Docs page.
* /src/pages: Pages for each item in page menu.

> Modifications to Docs should be done against [/docs][docsurl] branch.
* Instructions to deploy (only for collaborators):
* `npm deploy` will upload source code to <https://github.com/angrykoala/gaucho/tree/gh-pages>

### Troubleshooting

Expand All @@ -94,3 +109,5 @@ Gaucho is being developed and maintained as Open-Source software by @angrykoala
The original source code can be found at: <https://github.com/angrykoala/gaucho>

> You can find more information about Gaucho License [here](https://angrykoala.github.io/gaucho/license)

[docsurl]:https://github.com/angrykoala/gaucho/tree/docs