Verified Commit e3c7a7cb authored by Aral Balkan's avatar Aral Balkan
Browse files

Break out the Docs docs into separate pages

parent d9ec07ce
+++
title = "Docs"
alwaysopen = "true"
+++
This is the documentation on the documentation project (this). Very meta.
## Process
The Docs project is used both for planning artefacts and to document the various projects under the Indienet banner as they are developed.
## Development
Docs is built using [Hugo](https://gohugo.io). See the Hugo [quick start guide](https://gohugo.io/getting-started/quick-start/) to install Hugo on your system.
We use [our fork](https://github.com/aral/hugo-theme-docdock) of the [Hugo DocDock Theme](http://docdock.netlify.com/). The fork currently fixes [an issue with search highlighting breaking in Mermaid sequence diagrams](https://github.com/vjeantet/hugo-theme-docdock/issues/112)). (The fix [has now been merged into master](https://github.com/vjeantet/hugo-theme-docdock/pull/113).)
To contribute to the project, team members should [fork the repository on source.ind.ie](https://source.ind.ie/indienet/docs) and submit merge requests.
## Installation
1. Clone the repository
2. Install the theme (`git submodule update --init`)
## Running
```bash
hugo server -D
```
(This will run a local dev server and locally publish the site, including drafts.)
## Deployment
If you have deployment privileges, you can deploy via Git:
```bash
git push deploy master
```
This will push to the deployment mirror repository on GitHub which will trigger [Netlify](https://gohugo.io/hosting-and-deployment/hosting-on-netlify/) to build it via Hugo and deploy it to [indienet.info](https://indienet.info).
See [netlify.toml](https://source.ind.ie/indienet/docs/blob/master/netlify.toml) for the deployment configuration.
## Multilanguage support
The docs are currently only in English.
This should change shortly as our team in Ghent joins the project.
This is the documentation for the Docs project itself.
Both Hugo and this theme support [multilingual development](https://gohugo.io/content-management/multilingual/). The configuration has been set up so that adding support for new languages is seamless and trivial. (Also see the docs for [multilingual development and internationalisation for the Learn Theme](https://learn.netlify.com/en/cont/i18n/) – the DocDock theme is forked from it.)
The Docs project is used to document the various Indienet projects as they are being developed. Depending on the stage of development, it will contain planning artefacts, development documentation, and usage documentation.
+++
title = "Deploy"
weight = "50"
+++
If you have deployment privileges, run the `./deploy` script.
Or, manually:
```bash
git push deploy master
```
This will push to the deployment mirror repository on GitHub which will trigger [Netlify](https://gohugo.io/hosting-and-deployment/hosting-on-netlify/) to build it via Hugo and deploy it to [indienet.info](https://indienet.info).
See [netlify.toml](https://source.ind.ie/indienet/docs/blob/master/netlify.toml) for the deployment configuration.
+++
title = "Develop"
weight = "30"
+++
Run the `./dev` script.
Or, manually:
```bash
hugo server -D
```
(This will run a local dev server and locally publish the site, including drafts.)
+++
title = "Install"
weight = "20"
+++
1. **Clone the repository:**
* HTTPS (doesn’t require authentication):
```bash
git clone https://source.ind.ie/indienet/docs.git
```
* SSH (if you have a development account):
```bash
git clone git@source.ind.ie:indienet/docs.git
```
2. **Run the `./install` script.**
Or, manually:
1. Add the deployment remote:
```bash
git remote add deploy git@github.com:indie-mirror/indienet-docs.git
```
2. Install and update the theme:
```bash
git submodule update --init
```
+++
title = "Multilingual Support"
weight = "60"
+++
The docs are currently only in English.
This should change shortly as our team in Ghent joins the project.
Both Hugo and this theme support [multilingual development](https://gohugo.io/content-management/multilingual/). This project has been configured so that adding support for new languages is trivial.
For additional reference, see the docs for [multilingual development and internationalisation for the Learn Theme](https://learn.netlify.com/en/cont/i18n/) – the DocDock theme is forked from it.)
+++
title = "Overview"
weight = "10"
+++
Docs is built using [Hugo](https://gohugo.io). See the Hugo [quick start guide](https://gohugo.io/getting-started/quick-start/) to install Hugo on your system.
We use [our fork](https://github.com/aral/hugo-theme-docdock) of the [Hugo DocDock Theme](http://docdock.netlify.com/).[^1]
To contribute to the project, team members should [fork the repository on source.ind.ie](https://source.ind.ie/indienet/docs) and submit merge requests.
[^1]: The fork currently fixes [an issue with search highlighting breaking in Mermaid sequence diagrams](https://github.com/vjeantet/hugo-theme-docdock/issues/112)). (The fix [has now been merged into master](https://github.com/vjeantet/hugo-theme-docdock/pull/113).)
+++
title = "Update"
weight = "40"
+++
Run the `./update` script.
Or, manually:
```bash
git pull && git submodule update
```
(This will pull the latest changes to the content and also update the theme.)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment