[issue-24] Reorganize documents into docs/ directory and update links…

… to definitions docs
honzasterba · Sep 30, 2018 · 3bf4c03 · 3bf4c03
1 parent c12d9cd
commit 3bf4c03
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,6 @@
 .DS_Store
 *.gem
 nbproject
-doc/
 rdoc/
 Gemfile.lock
 .ruby-version

diff --git a/README.md b/README.md
@@ -175,7 +175,7 @@ Holidays for the regions specified within the dates specified will be pre-calcul
 
 ### How to contribute
 
-See our [contribution guidelines](CONTRIBUTING.md) for information on how to help out!
+See our [contribution guidelines](doc/CONTRIBUTING.md) for information on how to help out!
 
 ### Credits and code
 

diff --git a/CONTRIBUTING.md → doc/CONTRIBUTING.md b/CONTRIBUTING.md → doc/CONTRIBUTING.md
@@ -4,7 +4,7 @@ There are multiple ways to help! We rely on users around the world to help keep
 
 ## Code of Conduct
 
-Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing. Everyone interacting with this project (or associated projects) is expected to abide by its terms.
+Please read our [Code of Conduct](../CODE_OF_CONDUCT.md) before contributing. Everyone interacting with this project (or associated projects) is expected to abide by its terms.
 
 ## General note
 
@@ -13,11 +13,11 @@ or, if you forgot to do so, run `make update-defs` so that all of the submodule
 
 ## For definition updates
 
-Our definitions are written in YAML. They are housed in a [separate repository](https://github.com/holidays/definitions) so that they can be used by tools written in other languages. You can find a complete guide to our format in the [definitions SYNTAX guide](https://github.com/holidays/definitions/blob/master/SYNTAX.md).
+Our definitions are written in YAML. They are housed in a [separate repository](https://github.com/holidays/definitions) so that they can be used by tools written in other languages. You can find a complete guide to our format in the [definitions SYNTAX guide](https://github.com/holidays/definitions/blob/master/doc/SYNTAX.md).
 
 In this ruby project we take the YAML definitions and generate final ruby classes that are loaded at runtime for fast calculations.
 
-Once you have a good idea on what you want to change, please see the [CONTRIBUTING guide](https://github.com/holidays/definitions/blob/master/CONTRIBUTING.md) in the `definitions` repository.
+Once you have a good idea on what you want to change, please see the [CONTRIBUTING guide](https://github.com/holidays/definitions/blob/master/doc/CONTRIBUTING.md) in the `definitions` repository.
 
 The idea is that if the validation passes on the other repo then you shouldn't have to worry about generating and testing here. We'll see how that goes!
 

diff --git a/MAINTAINERS.md → doc/MAINTAINERS.md b/MAINTAINERS.md → doc/MAINTAINERS.md
@@ -49,19 +49,19 @@ sections below.
 ### Release flow
 
 * Does this update require definition updates? If YES, then:
-  * Pull the latest `master` version of this ruby repository and run `make update-defs`. This will grab the latest version from the [definitions](https://github.com/holidays/definitions) repository. Run `git diff` to verify that the version of the submodule for the definitions matches the correct commit in the [definitions](https://github.com/holidays/definitions) repo.
+  * Pull the latest `master` version of this ruby repository and run `make update-defs`. This will grab the latest version from the [definitions](https://github.com/holidays/definitions) repository. Run `git diff` to verify that the version of the submodule for the definitions matches the latest commit in the [definitions](https://github.com/holidays/definitions) repo.
   * Run the `make generate` command. This will 'recompile' the ruby sources with the latest definitions.
   * Run `make test` and ensure that all of the tests pass. If any tests fail then do *not* merge and contact a [core member](https://github.com/orgs/holidays/teams/core/members) for assistance.
   * If all of the tests pass, update the `lib/holidays/version.rb` file to the new version. Reference the above [semver](http://semver.org/) rules for how to update versions.
-  * Make a branch on your fork and update the [CHANGELOG](https://github.com/holidays/holidays/blob/master/CHANGELOG.md) to reflect the latest changes. You do not need to put in all of the definition changes in this update, you can simply reference the other repository. See other entries in the CHANGELOG for examples.
-  * Open a PR against the new branch and merge it (this may require another maintainer for safety)
+  * Make a branch on your fork and update the [CHANGELOG](../CHANGELOG.md) to reflect the latest changes. You do not need to put in all of the definition changes in this update, you can simply reference the other repository. See other entries in the CHANGELOG for examples.
+  * Open a PR against the new branch and merge it (another maintainer will need to review before you can merge)
   * Once the branch is merged, pull down the latest master from Github and run `make build`. This will generate a new `gem` file with the new version. The new version number is pulled from the above `version.rb` update.
   * If the build was successful then you can run the following to push up to rubygems.org: `GEM=<gem> make push`. Example: `GEM=holidays-6.2.0.gem make push`
 * Does this update require functionality additions or bug fixes? If YES, then:
   * Run `make test` and ensure that all of the tests pass. If any tests fail then do *not* merge and contact a [core member](https://github.com/orgs/holidays/teams/core/members) for assistance.
-  * If all of the tests pass, make a branch on your fork and update the [CHANGELOG](https://github.com/holidays/holidays/blob/master/CHANGELOG.md) to reflect the latest changes.
+  * If all of the tests pass, make a branch on your fork and update the [CHANGELOG](../CHANGELOG.md) to reflect the latest changes.
   * Update the `lib/holidays/version.rb` file to the new version. Reference the above [semver](http://semver.org/) rules for how to update versions.
-  * Open a PR against the new branch and merge it (this may require another maintainer for safety)
+  * Open a PR against the new branch and merge it (another maintainer will need to review before you can merge)
   * Once the branch is merged, pull down the latest master from Github and run `make build`. This will generate a new `gem` file with the new version. The new version number is pulled from the above `version.rb` update.
   * If the build was successful then you can run the following to push up to rubygems.org: `GEM=<gem> make push`. Example: `GEM=holidays-6.2.0.gem make push`
 
@@ -79,4 +79,3 @@ are that there are issues in the definition-specific tests. This is most likely
 It is a known issue that the definitions do not have a good set of self-tests to ensure that they are internally consistent. This means that a failure in this
 repository could NOT be related to ruby specifically. It could be that the 'tests' specified in in the YAML files are incorrect! If you encounter errors here
 make sure that you don't assume that it is just a ruby error that is causing the issues!
-
diff --git a/REFERENCES → doc/REFERENCES b/REFERENCES → doc/REFERENCES