Skip to content

Commit 5b95c0e

Browse files
committed
Clarified the documentation README [ci skip]
The documentation README was previously intended to be read from the documentation repository, not from the source repository. This had the potential to give off the impression that documentation pull requests were not allowed, when exactly the opposite is the case. The README has been improved to make it more clear how to contribute pull requests to update the documentation. Thanks to Brent Connor [1] for pointing out this issue over at Stack Overflow [2]. [1]: https://stackoverflow.com/users/3954106/brent-connor [2]: http://stackoverflow.com/q/28705192/359284
1 parent 9ad1ed8 commit 5b95c0e

1 file changed

Lines changed: 13 additions & 6 deletions

File tree

docs/README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
Select2 Documentation
22
=====================
3-
This repository holds the latest documentation for [Select2][select2].
3+
[This repository][select2-docs-source] holds the latest documentation for
4+
[Select2][select2].
45

56
What is this?
67
-------------
7-
88
The documentation is automatically extracted from the `docs` directory at the
99
[Select2 source repository][select2-source]. This is done periodically by
1010
the maintainers of Select2.
1111

12-
**Pull requests will usually be ignored, documentation fixes should be made in
13-
the source repository.** We _may_ accept pull requests if they match the
14-
source `docs` directory, but for the most part pull requests will be closed on
15-
sight.
12+
How can I fix an issue in these docs?
13+
-------------------------------------
14+
If you are reading this from the source repository, within the `docs` directory,
15+
then you're already in the right place. You can fork the source repository,
16+
commit your changes, and then make a pull request and it will be reviewed.
17+
18+
**If you are reading this from the
19+
[documentation repository][select2-docs-source], you are in the wrong place.**
20+
Pull requests made directly to the documentation repository will be ignored and
21+
eventually closed, so don't do that.
1622

1723
How can I build these docs manually?
1824
------------------------------------
@@ -28,4 +34,5 @@ Which will start up the documentation on port 4000. You will need
2834

2935
[jekyll]: http://jekyllrb.com/
3036
[select2]: https://select2.github.io
37+
[select2-docs-source]: https://github.com/select2/select2.github.io
3138
[select2-source]: https://github.com/select2/select2

0 commit comments

Comments
 (0)