From 2c7fb044267c9639a46f8d930d20dc7570bc6931 Mon Sep 17 00:00:00 2001 From: Dan Graham Date: Tue, 22 May 2018 10:32:44 -0700 Subject: [PATCH] Explain how to generate docs (#10541) * Explain how to generate docs * Documentation updates --- docs/en/contributing-to-appium/developers-overview.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/en/contributing-to-appium/developers-overview.md b/docs/en/contributing-to-appium/developers-overview.md index 791ab0541..ce3961ae3 100644 --- a/docs/en/contributing-to-appium/developers-overview.md +++ b/docs/en/contributing-to-appium/developers-overview.md @@ -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` and hit "Edit Tag". Make the release name `` (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`.