Skip to content

Commit 6358711

Browse files
navarretedanielbbengfort
authored andcommitted
Update hyperlinks in repo documentation (.md) files. (DistrictDataLabs#998)
1 parent 945b56e commit 6358711

File tree

4 files changed

+13
-14
lines changed

4 files changed

+13
-14
lines changed

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to Yellowbrick
22

3-
**NOTE: This document is a "getting started" summary for contributing to the Yellowbrick project.** To read the full contributor's guide, please visit the [contributing page](http://www.scikit-yb.org/en/latest/about.html#contributing) in the documentation. Please make sure to read this page carefully to ensure the review process is as smooth as possible and to ensure the greatest likelihood of having your contribution be merged.
3+
**NOTE: This document is a "getting started" summary for contributing to the Yellowbrick project.** To read the full contributor's guide, please visit the [contributing page](http://www.scikit-yb.org/en/latest/contributing/index.html) in the documentation. Please make sure to read this page carefully to ensure the review process is as smooth as possible and to ensure the greatest likelihood of having your contribution be merged.
44

55
For more on the development path, goals, and motivations behind Yellowbrick, check out our developer presentation: [Visualizing Model Selection with Scikit-Yellowbrick: An Introduction to Developing Visualizers](http://www.slideshare.net/BenjaminBengfort/visualizing-model-selection-with-scikityellowbrick-an-introduction-to-developing-visualizers).
66

@@ -16,11 +16,11 @@ Beyond creating visualizers, there are many ways to contribute:
1616
- Contribute a Jupyter notebook to our examples[ gallery](https://github.com/DistrictDataLabs/yellowbrick/tree/develop/examples).
1717
- Assist us with [user testing](http://www.scikit-yb.org/en/latest/evaluation.html).
1818
- Add to the documentation or help with our website, [scikit-yb.org](http://www.scikit-yb.org).
19-
- Write unit or integration tests for our project.
19+
- Write [unit or integration tests](https://www.scikit-yb.org/en/latest/contributing/developing_visualizers.html#integration-tests) for our project.
2020
- Answer questions on our issues, mailing list, Stack Overflow, and elsewhere.
2121
- Translate our documentation into another language.
2222
- Write a blog post, tweet, or share our project with others.
23-
- Teach someone how to use Yellowbrick.
23+
- [Teach](https://www.scikit-yb.org/en/latest/teaching.html) someone how to use Yellowbrick.
2424

2525
As you can see, there are lots of ways to get involved and we would be very happy for you to join us! The only thing we ask is that you abide by the principles of openness, respect, and consideration of others as described in the [Python Software Foundation Code of Conduct](https://www.python.org/psf/codeofconduct/).
2626

@@ -250,7 +250,7 @@ $ pytest tests/test_your_visualizer.py
250250

251251
The Makefile uses the pytest runner and testing suite as well as the coverage library, so make sure you have those dependencies installed!
252252

253-
**Note**: Advanced developers can use our _image comparison tests_ to assert that an image generated matches a baseline image. Read more about this in our [testing documentation](http://www.scikit-yb.org/en/latest/contributing.html#testing)
253+
**Note**: Advanced developers can use our _image comparison tests_ to assert that an image generated matches a baseline image. Read more about this in our [testing documentation](https://www.scikit-yb.org/en/latest/contributing/developing_visualizers.html#image-comparison-tests).
254254

255255
### Documentation
256256

@@ -296,4 +296,4 @@ class MyVisualizer(Visualizer):
296296
"""
297297
```
298298

299-
This is a very good start to producing a high quality visualizer, but unless it is part of the documentation on our website, it will not be visible. For details on including documentation in the `docs` directory see the [Contributing Documentation](http://www.scikit-yb.org/en/latest/contributing.html#documentation) section in the larger contributing guide.
299+
This is a very good start to producing a high quality visualizer, but unless it is part of the documentation on our website, it will not be visible. For details on including documentation in the `docs` directory see the [Contributing Documentation](https://www.scikit-yb.org/en/latest/contributing/index.html) section in the larger contributing guide.

DESCRIPTION.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,7 @@ Visualizers are estimators — objects that learn from data — whose pr
6363
- **t-SNE Corpus Visualization**: uses stochastic neighbor embedding to project documents
6464
- **UMAP Corpus Visualization**: plot similar documents closer together to discover clusters
6565

66-
... and more! Yellowbrick is adding new visualizers all the time so be sure to check out our [examples gallary](https://www.scikit-yb.org/en/latest/api/index.html) — or even the [develop](https://github.com/districtdatalabs/yellowbrick/tree/develop) branch — and feel free to contribute your ideas for new Visualizers!
66+
... and more! Yellowbrick is adding new visualizers all the time so be sure to check out our [examples gallery]https://github.com/DistrictDataLabs/yellowbrick/tree/develop/examples) — or even the [develop](https://github.com/districtdatalabs/yellowbrick/tree/develop) branch — and feel free to contribute your ideas for new Visualizers!
6767

6868
## Affiliations
6969
[![District Data Labs](https://github.com/DistrictDataLabs/yellowbrick/raw/develop/docs/images/readme/affiliates_ddl.png)](https://www.districtdatalabs.com/) [![NumFOCUS Affiliated Project](https://github.com/DistrictDataLabs/yellowbrick/raw/develop/docs/images/readme/affiliates_numfocus.png)](https://numfocus.org/)
70-

MAINTAINERS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This file describes how the Yellowbrick project is maintained and provides conta
44

55
When creating a pull request, your contribution will be reviewed by one or probably two maintainers who will give you the :+1: when your extension is ready to be merged. Maintainers work hard to ensure that Yellowbrick is a high quality project and that contributors are successful.
66

7-
For more about how to develop visualizers and contribute features to Yellowbrick, see our [contributor's guide](CONTRIBUTING.md) and the documentation.
7+
For more about how to develop visualizers and contribute features to Yellowbrick, see our [contributor's guide](CONTRIBUTING.md) and the [documentation](https://www.scikit-yb.org/en/latest/contributing/index.html).
88

99
For everyone who has [contributed](https://github.com/DistrictDataLabs/yellowbrick/graphs/contributors) in big and in small ways, **thank you!**. Yellowbrick is intended to be a community project, welcoming to new and experienced developers alike. If you would like to become a core contributor you must simply submit a pull request that shows core knowledge of the Yellowbrick library. Usually new Visualizers meet this standard; let the maintainers know you'd like to join the team, and they'll help you work toward it!
1010

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -72,27 +72,27 @@ visualizer.score(X,y)
7272
visualizer.show()
7373
```
7474

75-
For additional information on getting started with Yellowbrick, view the quickstart guide in the [documentation](https://www.scikit-yb.org/en/latest/) and check out our [examples notebook](https://github.com/DistrictDataLabs/yellowbrick/blob/develop/examples/examples.ipynb).
75+
For additional information on getting started with Yellowbrick, view the [Quick Start Guide](https://www.scikit-yb.org/en/latest/quickstart.html) in the [documentation](https://www.scikit-yb.org/en/latest/) and check out our [examples notebook](https://github.com/DistrictDataLabs/yellowbrick/blob/develop/examples/examples.ipynb).
7676

7777
## Contributing to Yellowbrick
7878

7979
Yellowbrick is an open source project that is supported by a community who will gratefully and humbly accept any contributions you might make to the project. Large or small, any contribution makes a big difference; and if you've never contributed to an open source project before, we hope you will start with Yellowbrick!
8080

81-
If you are interested in contributing, check out our [contributor's guide](https://www.scikit-yb.org/en/latest/contributing.html). Beyond creating visualizers, there are many ways to contribute:
81+
If you are interested in contributing, check out our [contributor's guide](https://www.scikit-yb.org/en/latest/contributing/index.html). Beyond creating visualizers, there are many ways to contribute:
8282

8383
- Submit a bug report or feature request on [GitHub Issues](https://github.com/DistrictDataLabs/yellowbrick/issues).
84-
- Contribute a Jupyter notebook to our examples[ gallery](https://github.com/DistrictDataLabs/yellowbrick/tree/develop/examples).
84+
- Contribute a Jupyter notebook to our examples [gallery](https://github.com/DistrictDataLabs/yellowbrick/tree/develop/examples).
8585
- Assist us with [user testing](https://www.scikit-yb.org/en/latest/evaluation.html).
8686
- Add to the documentation or help with our website, [scikit-yb.org](https://www.scikit-yb.org).
87-
- [Write unit or integration tests](https://www.scikit-yb.org/en/latest/contributing.html#testing) for our project.
87+
- Write [unit or integration tests](https://www.scikit-yb.org/en/latest/contributing/developing_visualizers.html#integration-tests) for our project.
8888
- Answer questions on our issues, mailing list, Stack Overflow, and elsewhere.
8989
- Translate our documentation into another language.
9090
- Write a blog post, tweet, or share our project with others.
91-
- Teach someone how to use Yellowbrick.
91+
- [Teach](https://www.scikit-yb.org/en/latest/teaching.html) someone how to use Yellowbrick.
9292

9393
As you can see, there are lots of ways to get involved and we would be very happy for you to join us! The only thing we ask is that you abide by the principles of openness, respect, and consideration of others as described in the [Python Software Foundation Code of Conduct](https://www.python.org/psf/codeofconduct/).
9494

95-
For more information, checkout the `CONTRIBUTING.md` file in the root of the repository or the detailed documentation at [Contributing to Yellowbrick](https://www.scikit-yb.org/en/latest/contributing.html)
95+
For more information, checkout the `CONTRIBUTING.md` file in the root of the repository or the detailed documentation at [Contributing to Yellowbrick](https://www.scikit-yb.org/en/latest/contributing/index.html)
9696

9797
## Yellowbrick Datasets
9898

0 commit comments

Comments
 (0)