Skip to content

Commit

Permalink
Canonicalise more webpage docs + fix relative links (kube-rs#868)
Browse files Browse the repository at this point in the history
* Canonicalise links for embedded website docs

Signed-off-by: clux <[email protected]>

* same for security

Signed-off-by: clux <[email protected]>

* move architecture to website

Signed-off-by: clux <[email protected]>

* forgot to remove maintainers as well

Signed-off-by: clux <[email protected]>

* move governance as well

Signed-off-by: clux <[email protected]>
  • Loading branch information
clux authored Apr 3, 2022
1 parent 057b935 commit 7b2d145
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 294 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ The following breaking changes were made as a part of an effort to refine errors
* `kube::runtime::wait::conditions` added `is_crd_established` helper - [#659](https://github.com/kube-rs/kube-rs/issues/659)
* `kube::CustomResource` derive can now take an arbitrary `#[kube(kube_core)]` path for `kube::core` - [#658](https://github.com/kube-rs/kube-rs/issues/658)
* `kube::core` consistently re-exported across crates
* docs: major overhaul + [architecture.md](./architecture.md) - [#416](https://github.com/kube-rs/kube-rs/issues/416) via [#652](https://github.com/kube-rs/kube-rs/issues/652)
* docs: major overhaul + [architecture.md](https://kube.rs/architecture/) - [#416](https://github.com/kube-rs/kube-rs/issues/416) via [#652](https://github.com/kube-rs/kube-rs/issues/652)

[0.61.0](https://github.com/kube-rs/kube-rs/releases/tag/0.61.0) / 2021-10-09
===================
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ More information about `DCO` can be found [here](https://developercertificate.or
All code that is contributed to kube-rs must go through the Pull Request (PR) process.
To contribute a PR, fork this project, create a new branch, make changes on that branch, and then use GitHub to open a pull request with your changes.

Every PR must be reviewed by at least one [Maintainer](./maintainers.md) of the project.
Every PR must be reviewed by at least one [Maintainer](https://kube.rs/maintainers/) of the project.
Once a PR has been marked "Approved" by a Maintainer (and no other Maintainer has an open "Rejected" vote), the PR may be merged.
While it is fine for non-maintainers to contribute their own code reviews, those reviews do not satisfy the above requirement.

Expand Down Expand Up @@ -75,7 +75,7 @@ All public interfaces should have doc tests with examples for [docs.rs](https://

When adding new non-trivial pieces of logic that results in a drop in coverage you should add a test.

Cross-reference with the coverage build [![coverage build](https://codecov.io/gh/kube-rs/kube-rs/branch/master/graph/badge.svg?token=9FCqEcyDTZ)](https://codecov.io/gh/kube-rs/kube-rs) and go to your branch. Coverage can also be run locally with [`cargo tarpaulin`](https://github.com/xd009642/tarpaulin) at project root. This will use our [tarpaulin.toml](./tarpaulin.toml) config, and **will run both unit and integration** tests.
Cross-reference with the coverage build [![coverage build](https://codecov.io/gh/kube-rs/kube-rs/branch/master/graph/badge.svg?token=9FCqEcyDTZ)](https://codecov.io/gh/kube-rs/kube-rs) and go to your branch. Coverage can also be run locally with [`cargo tarpaulin`](https://github.com/xd009642/tarpaulin) at project root. This will use our [tarpaulin.toml](https://github.com/kube-rs/kube-rs/blob/master/tarpaulin.toml) config, and **will run both unit and integration** tests.

#### What type of test

Expand All @@ -95,7 +95,7 @@ In general: **use the least powerful method** of testing available to you:

## Support
### Documentation
The [high-level architecture document](./architecture.md) is written for contributors.
The [high-level architecture document](https://kube.rs/architecture/) is written for contributors.

### Contact
You can ask general questions / share ideas / query the community at the [kube-rs discussions forum](https://github.com/kube-rs/kube-rs/discussions).
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Once `0.71.1` is released, we will no longer provide updates for `0.69` releases

## Reporting a Vulnerability

To report a security problem in Kube-rs, please contact at least two [maintainers][./maintainers.md]
To report a security problem in Kube-rs, please contact at least two [maintainers](https://kube.rs/maintainers/)

These people will help diagnose the severity of the issue and determine how to address the issue.
Issues deemed to be non-critical will be filed as GitHub issues.
Expand Down
Loading

0 comments on commit 7b2d145

Please sign in to comment.