github/svgedit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Docs: Reference JSDocs in README

Browse Source 
- Docs (ReleaseInstructions): Clarify README changing; lbs
This commit is contained in:
Brett Zamir
2018-05-30 11:40:55 +08:00
parent df69ba2b72
commit 41201cf452
2 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -63,7 +63,7 @@ The following browsers had been tested for 2.6 or earlier and will probably cont
## Further reading and more information ## Further reading and more information
* See [docs](docs/) for more documentation. * See [docs](docs/) for more documentation. See the [JSDocs for our latest release](https://svg-edit.github.io/svgedit/releases/svg-edit-3.0.0-alpha.4/docs/jsdoc/index.html).
* [Acknowledgements](docs/Acknowledgements.md) lists open source projects used in svg-edit. * [Acknowledgements](docs/Acknowledgements.md) lists open source projects used in svg-edit.
* See [AUTHORS](AUTHORS) file for authors. * See [AUTHORS](AUTHORS) file for authors.
* [Stackoverflow](https://stackoverflow.com/tags/svg-edit) group. * [Stackoverflow](https://stackoverflow.com/tags/svg-edit) group.

24
docs/ReleaseInstructions.md
View File

@@ -4,9 +4,10 @@
<!-- <!--
1. Update the VERSION variable in Makefile. 1. Update the VERSION variable in Makefile.
--> -->
1. Update `version` in `package.json` (and `package-lock.json` (via `npm i`)) 1. Update `version` in `package.json` (and `package-lock.json` (via `npm i`)).
1. Update the CHANGES file with a summary of all changes. 1. Update the CHANGES file with a summary of all changes.
1. Update the README to point to the current version (it will not be available until the steps below) 1. Update the README references to `svg-edit.github.io` to point to the
current version (note that it will not be available until the steps below).
1. Commit these changes 1. Commit these changes
<!-- with `git commit -m "Updating Makefile and CHANGES for release X.Y"`-->. <!-- with `git commit -m "Updating Makefile and CHANGES for release X.Y"`-->.
1. Tag the version, prefixed by "v", e.g., `v3.0.1`. 1. Tag the version, prefixed by "v", e.g., `v3.0.1`.
@@ -22,13 +23,13 @@ The above steps can be done on a fork and committed via a pull request.
1. Ensure you are on the `master` branch with `git checkout master`. 1. Ensure you are on the `master` branch with `git checkout master`.
1. Switch to the `gh-pages` branch with `git checkout gh-pages`. 1. Switch to the `gh-pages` branch with `git checkout gh-pages`.
1. Copy the `svg-edit-X.Y` directory to `releases/svg-edit-X.Y` (minus 1. Copy the `svg-edit-X.Y` directory to `releases/svg-edit-X.Y` (minus
`.git` and `.gitignore` and including the working built `.git` and `.gitignore` and including the working built
`svgedit-config-es.js` and `svgedit-config-iife.js` files). `svgedit-config-es.js` and `svgedit-config-iife.js` files).
1. Commit these changes with `git commit -m "Updating files for release X.Y"`. 1. Commit these changes with `git commit -m "Updating files for release X.Y"`.
1. Switch back to the `master` branch with `git checkout master`. 1. Switch back to the `master` branch with `git checkout master`.
1. Ensure this step worked by visiting <https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html> 1. Ensure this step worked by visiting <https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html>
(and in an ES6-Module-compliant browser, (and in an ES6-Module-compliant browser,
<https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor-es.html>) <https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor-es.html>).
The above steps can be done on a fork and committed via a pull request. The above steps can be done on a fork and committed via a pull request.
@@ -36,11 +37,14 @@ The above steps can be done on a fork and committed via a pull request.
<!-- <!--
4. Attach the `svg-edit-X.Y-src.tar.gz` and `build/svg-edit-X.Y.zip` files to the release. 4. Attach the `svg-edit-X.Y-src.tar.gz` and `build/svg-edit-X.Y.zip` files to the release.
--> -->
1. Go to <https://github.com/SVG-Edit/svgedit/releases> and select `Draft a new release`. 1. Go to <https://github.com/SVG-Edit/svgedit/releases> and select
1. Make the release target point at the commit where the <!-- makefile and --> changes were updated. `Draft a new release`.
1. Write a short description of the release and include a link to the live version: 1. Make the release target point at the commit where the <!-- makefile and -->
<https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html>. changes were updated.
See the previous releases for the format. 1. Write a short description of the release and include a link to the live
version:
<https://svgedit.github.io/svgedit/releases/svg-edit-X.Y/svg-editor.html>.
See the previous releases for the format.
1. Create the release! 1. Create the release!
You will need to be a member of the SVG-Edit GitHub group to do this step. You will need to be a member of the SVG-Edit GitHub group to do this step.