https://github.com/emberjs/api.emberjs.com
Repo to handle publication of API documentation for the Ember.js family of libraries
https://github.com/emberjs/api.emberjs.com
Last synced: 6 months ago
JSON representation
Repo to handle publication of API documentation for the Ember.js family of libraries
- Host: GitHub
- URL: https://github.com/emberjs/api.emberjs.com
- Owner: emberjs
- Archived: true
- Created: 2015-02-11T17:06:53.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-04-05T15:05:21.000Z (about 11 years ago)
- Last Synced: 2024-10-29T14:53:47.467Z (over 1 year ago)
- Language: HTML
- Size: 1.38 MB
- Stars: 0
- Watchers: 13
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# READ-ONLY READ-ONLY READ-ONLY
This repo is a READ-ONLY repo. It contains the built output of the content
from https://github.com/emberjs/api. If you would like to make corrections
or additions to a guide, please open a pull request at
https://github.com/emberjs/api.
## Publishing
### General Contributors
### Release Team
These instructions are for publishing a new version of the site at http://guides.emberjs.com.
You should already have followed the directions at https://github.com/emberjs/api for building
a new version of the api and have moved the output of this process into `./snapshots`
This section is intended for members of the Ember.js release team or those contributors wishing to augment or
change or publication process. If you want to publish your own version of the guides, see ### General Contributors
above.
### Github
When ready for a new release, make sure your latest content is pushed to https://github.com/emberjs/api and tagged with a verison number:
```
git tag
git push --tags
```
For `` we use the following format `v..`, so
`v1.10.0` is correct but `1.9.1` is not.
### Site
The site can be published via the Divshot cli:
```shell
divshot push
```
Verify that the content looks good at:
http://development.ember-api.divshot.io/
If there are no obvious defects, promote the assets in the development environment to production
```shell
divshot promote development production
```
### Search
Publish the searchable content of the revison you are publshing:
```shell
npm deploy:search --revision
--environment
--api-key
--engine
# e.g.
npm deploy:search --revision v1.1.1 --environment staging --api-key SUPERSECRETBROCOMMON --engine ember
```
### Versions
To update the list of versions run the following:
```shell
node tasks/update-versions.js
```