diff --git a/_contrib/governance.md b/_contrib/governance.md index 0b88af8..9a9fe06 100644 --- a/_contrib/governance.md +++ b/_contrib/governance.md @@ -20,21 +20,21 @@ users. Some actively contribute their thoughts, but many others we must seek out to learn about their usage, joys, and headaches. Those insights allow our experts to determine the best solutions for the users. -We then define a set of [TENETS](./tenets.md), which are guiding principles +We then define a set of [tenets](./tenets.md), which are guiding principles that can be used to measure aspects of individual decisions. It should be possible to identify one or more tenets that apply to why a decision is made. And the set helps us balance which priorities are more important for our users. -We combine the usecases with the tenets to come up with a [VISION](./vision.md) +We combine the usecases with the tenets to come up with a [vision](./vision.md) that provides a longer-term plan of what hyper _should_ look like. -Finally, we define a [ROADMAP](./roadmap.md) that describes what the +Finally, we define a [roadmap](./roadmap.md) that describes what the short-term, tactical changes to bring hyper closer in line with the vision. ## Roles These are the roles people can fill when participating in the project. A list -of the people in each role is available in [MAINTAINERS](./maintainers.md). +of the people in each role is available in [maintainers](./maintainers.md). ### Contributor @@ -79,7 +79,7 @@ Collaborators are contributors who have been helping out in a consistent basis. Responsibilities: - Be exemplars of the [Code of Conduct][coc] -- Internalize the [VISION](./vision.md) +- Internalize the [vision](./vision.md) - Reviewing pull requests from other contributors - Provide feedback on proposed features and design documents - [Welcome new contributors][triage-guide] diff --git a/_contrib/maintainers.md b/_contrib/maintainers.md index b163998..bb576f9 100644 --- a/_contrib/maintainers.md +++ b/_contrib/maintainers.md @@ -3,7 +3,7 @@ title: The People layout: guide --- -To see what these roles do, and how to become one, look at [GOVERNANCE](./governance.md). +To see what these roles do, and how to become one, look at [governance](./governance.md). ## Triagers diff --git a/_contrib/roadmap.md b/_contrib/roadmap.md index 2be3e20..061a6df 100644 --- a/_contrib/roadmap.md +++ b/_contrib/roadmap.md @@ -5,12 +5,12 @@ layout: guide ## Goal -Align current hyper to the [hyper VISION][VISION]. +Align current hyper to the [hyper vision][vision]. -The VISION outlines a decision-making framework, use-cases, and general shape +The vision outlines a decision-making framework, use-cases, and general shape of hyper. This roadmap describes the currently known problems with hyper, and then shows what changes are needed to make hyper 1.0 look more like what is in -the VISION. +the vision. ## Known Issues @@ -142,7 +142,7 @@ more to encourage best practices? ## Design -The goal is to get hyper closer to the [VISION][], using that to determine the +The goal is to get hyper closer to the [vision][], using that to determine the best way to solve the known issues above. The main thrust of the proposed changes are to make hyper more **Flexible** and stable. @@ -166,7 +166,7 @@ For example, there will now be `hyper::server::conn::http1::Connection` and `hyper::server::conn::http2::Connection` types. These specific types will still have a very similar looking API that, as the -VISION describes, provides **Correct** connection management as it pertains to +vision describes, provides **Correct** connection management as it pertains to HTTP. There will be still be a type to wrap the different versions. It will no longer @@ -390,7 +390,7 @@ abstraction, and then make an internal adapter. ### Isn't this making hyper harder? -We are making hyper more **flexible**. As noted in the [VISION][], most use +We are making hyper more **flexible**. As noted in the [vision][], most use cases of hyper require it to be flexible. That _can_ mean that the exposed API is lower level, and that it feels more complicated. It should still be **understandable**. @@ -403,5 +403,5 @@ they need, we will also write guides for the [hyper.rs][] showing people how to accomplish the most common tasks. [timeline]: https://seanmonstar.com/post/676912131372875776/hyper-10-timeline -[VISION]: https://github.com/hyperium/hyper/pull/2772 +[vision]: https://github.com/hyperium/hyper/pull/2772 [hyper.rs]: https://hyper.rs diff --git a/_contrib/vision.md b/_contrib/vision.md index 76a3241..f6b503b 100644 --- a/_contrib/vision.md +++ b/_contrib/vision.md @@ -28,7 +28,7 @@ that come later (but every case is different). 4. Flexible 5. Understandable -There's a lot more detail about each in [TENETS](./tenets.md). +There's a lot more detail about each in [tenets](./tenets.md). ## Use Cases