mirror of
https://github.com/appium/appium.git
synced 2026-10-29 04:36:39 +08:00
Explain how to generate docs (#10541)
* Explain how to generate docs * Documentation updates
This commit is contained in:
committed by
Isaac A. Murchie
parent
3da489ce5e
commit
2c7fb04426
@@ -187,7 +187,15 @@ converted into the `npm-shrinkwrap.json` file.
|
||||
1. Install dev dependencies (or at least `gulp` and `appium-gulp-plugins`), and undo the changes to the NPM shrinkwrap JSON file (e.g., `git checkout -- npm-shrinkwrap.json`).
|
||||
1. Run `npm publish` (with `--tag beta` if this isn't an official release).
|
||||
1. Remove the NPM shrinkwrap JSON file from Git and push the changes
|
||||
1. Update the docs at appium.io. Check out the appium.io repo from github, check out the `gh-pages` branch and pull latest. Run `rake publish`.
|
||||
1. Update the site docs or put in an [issue](https://github.com/appium/appium/issues) to have the site docs updated
|
||||
* From Appium repo, run `npm run generate-docs` and make a pull request if there are any newly generated docs.
|
||||
* When the above PR is merged, clone the [appium.io](https://github.com/appium/appium.io) repo (if you haven't done so already)
|
||||
* Check out and pull the latest `gh-pages` branch
|
||||
* Follow the setup guide in the README.md
|
||||
* Generate the docs by running `npm run build:docs`
|
||||
* Test by running `npm run serve` and navigating to https://localhost:4000/
|
||||
* Make a new branch
|
||||
* Commit and push changes and make a pull request to have changes merged into `gh-pages`
|
||||
1. Create a new release on GitHub: go to `https://github.com/appium/appium/releases/tag/v<VERSION>` and hit "Edit Tag". Make the release name `<VERSION>` (e.g., `2.0.5`), then paste in the changelog (but not the changelog header for this version). If it's a beta release, mark as pre-release.
|
||||
1. Create a new post on discuss.appium.io announcing the release. Post it in the "News" category. Paste in the changelog and any choice comments. Pin it and unpin the previous release post.
|
||||
1. Begin process of releasing `appium-desktop`.
|
||||
|
||||
Reference in New Issue
Block a user