https://github.com/semaphoreci/docs
Semaphore 2.0 documentation.
https://github.com/semaphoreci/docs
continuous-delivery continuous-deployment continuous-integration documentation semaphoreci
Last synced: 6 months ago
JSON representation
Semaphore 2.0 documentation.
- Host: GitHub
- URL: https://github.com/semaphoreci/docs
- Owner: semaphoreci
- Created: 2018-07-11T13:11:29.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-19T12:12:35.000Z (over 2 years ago)
- Last Synced: 2023-12-19T12:50:43.092Z (over 2 years ago)
- Topics: continuous-delivery, continuous-deployment, continuous-integration, documentation, semaphoreci
- Language: HTML
- Homepage: https://docs.semaphoreci.com
- Size: 49.7 MB
- Stars: 15
- Watchers: 13
- Forks: 92
- Open Issues: 57
-
Metadata Files:
- Readme: README-dev.md
- Contributing: CONTRIBUTING.md
- Security: docs/security/audit-events-reference.md
Awesome Lists containing this project
README
# Managing pages
Docs are self hosted. The following instructions apply for Semaphore team members:
## Creating new file
- Create file in repository `article-name`, example: `getting-started.md`
- In [mkdocs.yml](https://github.com/semaphoreci/docs/blob/master/mkdocs.yml), add the new article to the right category, e.g: `Getting started: guided-tour/getting-started.md`
- Every docs article must have an H1 which should correspond to its name in the mkdocs.yml file.
## Updating existing files
Updating existing files is done by entering a given file and modifying it.
## Development
### Managing assets
Semaphore team is using a private repository [public-assets]
to store CSS, JS and image files.
### Install dependencies
Currently, script depends on [redcarpet] gem.
It can be installed with the following command
``` bash
gem install redcarpet
```
### Set up secret
- `cp docs_secrets.yml.example docs_secrets.yml`
- update this file with your HelpScout Docs API Key
### Set up project on Semaphore
- add project to an org with `sem`
- propagate secret to Semaphore with `sem`
[HelpScout Docs token]: https://developer.helpscout.com/docs-api/
[redcarpet]: https://github.com/vmg/redcarpet
[update]: https://developer.helpscout.com/docs-api/articles/update/
[public-assets]: https://github.com/renderedtext/public-assets