https://github.com/contentful/slash-developers
THIS REPOSITORY IS DEPRECATED. Please do not open new PRs or issues.
https://github.com/contentful/slash-developers
Last synced: 10 months ago
JSON representation
THIS REPOSITORY IS DEPRECATED. Please do not open new PRs or issues.
- Host: GitHub
- URL: https://github.com/contentful/slash-developers
- Owner: contentful
- Archived: true
- Created: 2015-02-10T11:01:59.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-09-10T19:41:51.000Z (almost 8 years ago)
- Last Synced: 2025-03-06T12:54:13.905Z (over 1 year ago)
- Language: HTML
- Homepage:
- Size: 5.99 MB
- Stars: 13
- Watchers: 44
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# THIS REPOSITORY IS DEPRECATED
Please do not open new PRs or issues.
# Legacy README
## Contributing
- __Do not__ modify manually files in the `docs/` directory.
- __Do__ modify files in the `raw_dows/` directory.
- Before opening a PR, run `./generate-docs.sh`. It'll prepare files in the `/docs` directory as described below.
- Changes in both `raw_docs/` (manually introduced) and `docs/` (automatically generated) need to be committed to the repository.
- After opening a PR, ping developers and ask for a review.
## Documentation generation
Currently the `./generate-docs.sh` script does two things:
### Including other content
You can use [hercule](https://github.com/jamesramsay/hercule) to include (transclude) other partial markdown files and reduce repetition. You can find the current partial files in the `raw_docs/_partials` folder and you include them with the following syntax:
```
:[Getting started tutorial intro](../../_partials/getting-started-intro.md)
```
### Placeholders
Placeholders for variables in code examples are enclosed in angled brackets, for example:
```
```
When you build the documentation these are replaced with the real values you can find in `placeholder-replacements.sh` via the `sed` command. Feel free to add new variables you need.