Skip to content

Commit

Permalink
docs: Update README.md to be more helpful (#6585)
Browse files Browse the repository at this point in the history
The docs/README.md made no sense. Anyone reading it in GitHub clearly wants to
contribute to the documentation, that's why they're in the source code of
Contour, why else would they have found their way to the source repository? So,
it should point to where the documentation lives in the git repository, not to
the website where it's served.

Signed-off-by: James Roper <james@jazzy.id.au>
Co-authored-by: Steve Kriss <stephen.kriss@gmail.com>
  • Loading branch information
jroper and skriss authored Aug 23, 2024
1 parent 44bffe8 commit 20e57df
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
# Contour Documentation

The contents of this directory have moved to [projectcontour.io](https://projectcontour.io/).
Specifically;
The contents of this directory have moved to corresponding directories in [../site/content](../site/content).

* Guides and How-to's have moved to [projectcontour.io/guides](https://projectcontour.io/guides)
* Versioned release documentation has moved to [projectcontour.io/docs](https://projectcontour.io/docs)
* Project related and non-versioned documentation has moved to [projectcontour.io/resources](https://projectcontour.io/resources/)

For more about how we're thinking of Contour's future, check out [the design docs](../design/).
For more information on how to contribute to the Contour documentation, see the [Contour Technical Documentation Contributing Guide](https://projectcontour.io/resources/contributing-docs/).

0 comments on commit 20e57df

Please sign in to comment.