diff --git a/contributing/CODE-OF-CONDUCT.md b/contributing/CODE-OF-CONDUCT.md index 08c0961eb..3cdd794a7 100644 --- a/contributing/CODE-OF-CONDUCT.md +++ b/contributing/CODE-OF-CONDUCT.md @@ -2,6 +2,7 @@ title: "Contributor covenant code of conduct" linkTitle: "Code of conduct" weight: 10 +type: "docs" --- ## Our Pledge diff --git a/contributing/CONTRIBUTING.md b/contributing/CONTRIBUTING.md index d5cad6220..1567fb9ef 100644 --- a/contributing/CONTRIBUTING.md +++ b/contributing/CONTRIBUTING.md @@ -2,6 +2,7 @@ title: "Knative contributor guidelines" linkTitle: "Contributing to Knative" weight: 15 +type: "docs" --- So, you want to hack on Knative? Yay! @@ -25,18 +26,18 @@ given the same level of review. ## Working groups The Knative contributors community is organized into a set of -[working groups](WORKING-GROUPS.md). Any contribution to Knative should be +[working groups](WORKING-GROUPS/). Any contribution to Knative should be started by first engaging with the appropriate working group. ## Code of conduct All members of the Knative community must abide by the -[Code of Conduct](CODE-OF-CONDUCT.md). Only by respecting each other can we +[Code of Conduct](CODE-OF-CONDUCT/). Only by respecting each other can we develop a productive, collaborative community. ## Team values -We promote and encourage a set of [shared values](VALUES.md) to improve our +We promote and encourage a set of [shared values](VALUES/) to improve our productivity and inter-personal interactions. ## Contributor license agreements @@ -58,7 +59,7 @@ our [Team Drive](https://drive.google.com/corp/drive/folders/0APnJ_hRs30R2Uk9PVA) and sending an email to the appropriate working group's mailing list to let people know the doc is there. To get write access to the drive, you'll need to -be a [member](ROLES.md#member) of the Knative organization. +be a [member](ROLES/#member) of the Knative organization. We do not yet have a common design document template(TODO). @@ -77,7 +78,7 @@ later join knative-dev if you want immediate access). ## Contributing documentation For more information about contributing to the Knative documentation, see -[DOCS-CONTRIBUTING.md](DOCS-CONTRIBUTING.md). A lot of the information on this +[DOCS-CONTRIBUTING](DOCS-CONTRIBUTING/). A lot of the information on this page still applies, but you'll find the specifics about the docs process there. ## Contributing a feature @@ -85,7 +86,7 @@ page still applies, but you'll find the specifics about the docs process there. In order to contribute a feature to Knative you'll need to go through the following steps: -- Discuss your idea with the appropriate [working groups](WORKING-GROUPS.md) on +- Discuss your idea with the appropriate [working groups](WORKING-GROUPS/) on the working group's mailing list. - Once there is general agreement that the feature is useful, @@ -169,9 +170,9 @@ This project uses [Prow](https://github.com/kubernetes/test-infra/tree/master/prow) to assign reviewers to the PR, set labels, run tests automatically, and so forth. -See [Reviewing and Merging Pull Requests](REVIEWING.md) for the PR review and +See [Reviewing and Merging Pull Requests](REVIEWING/) for the PR review and merge process used for Knative and for more information about -[Prow](./REVIEWING.md#prow). +[Prow](./REVIEWING/#prow). ## Issues diff --git a/contributing/DOCS-CONTRIBUTING.md b/contributing/DOCS-CONTRIBUTING.md index 6a038509c..127060e4d 100644 --- a/contributing/DOCS-CONTRIBUTING.md +++ b/contributing/DOCS-CONTRIBUTING.md @@ -2,6 +2,7 @@ title: "Contributing to the Knative documentation" linkTitle: "Contributing to docs" weight: 20 +type: "docs" --- **First off, thanks for taking the time to contribute!** @@ -14,7 +15,7 @@ propose changes to this document in a pull request. ### Code of conduct -Knative follows the [Knative Code of Conduct](./CODE-OF-CONDUCT.md). By +Knative follows the [Knative Code of Conduct](./CODE-OF-CONDUCT/). By participating, you are expected to uphold this code. Please report unacceptable behavior to knative-code-of-conduct@googlegroups.com. @@ -38,7 +39,7 @@ see a problem with the documentation, submit an issue using the following steps: When you create a bug report, include as many details as possible and include suggested fixes to the issue. If you know which Knative component your bug is related to, you can assign the appropriate - [Working Group Lead](./WORKING-GROUPS.md). + [Working Group Lead](./WORKING-GROUPS/). - **Feature request**: For upcoming changes to the documentation or requests for more information on a particular subject. @@ -50,7 +51,7 @@ documentation issues should go in the `docs` repository. ### Working group -The [Knative Documentation Working Group](./WORKING-GROUPS.md#documentation) +The [Knative Documentation Working Group](./WORKING-GROUPS/#documentation) meets weekly on Tuesdays and alternates between a 9am PT and a 4:30pm PT time to accommodate contributors in both the EMEA and APAC timezones. [Click here](https://calendar.google.com/calendar/embed?src=google.com_18un4fuh6rokqf8hmfftm5oqq4%40group.calendar.google.com) @@ -67,7 +68,7 @@ There are a couple different ways to jump in to the Knative doc set: [Good First Issue](https://github.com/knative/docs/labels/kind%2Fgood-first-issue). - Run through the [install guide](../install/README.md) for the platform of your choice, as well as the - [Getting Started with Knative App Deployment](../install/getting-started-knative-app.md) + [Getting Started with Knative App Deployment](../install/getting-started-knative-app/) guide, and keep a [friction log](https://devrel.net/developer-experience/an-introduction-to-friction-logging) of the experience. What was hard for you? Then open a PR with a few diff --git a/contributing/README.md b/contributing/README.md index 9fa6b4513..419041bd2 100644 --- a/contributing/README.md +++ b/contributing/README.md @@ -1,6 +1,6 @@ _Important_. Before proceeding, please review the Knative community -[Code of Conduct](CODE-OF-CONDUCT.md). +[Code of Conduct](./CODE-OF-CONDUCT/). If you any have questions or concerns, please contact the authors at knative-code-of-conduct@googlegroups.com. @@ -21,25 +21,25 @@ improving docs, giving talks, etc. Other Documents -- [Code of Conduct](CODE-OF-CONDUCT.md) - all contributors must abide by the +- [Code of Conduct](./CODE-OF-CONDUCT/) - all contributors must abide by the code of conduct -- [Contributing to Knative](CONTRIBUTING.md) - guidelines and advice on becoming +- [Contributing to Knative](./CONTRIBUTING/) - guidelines and advice on becoming a contributor -- [Working Groups](WORKING-GROUPS.md) - describes our various working groups -- [Working Group Processes](WORKING-GROUP-PROCESSES.md) - describes how working +- [Working Groups](./WORKING-GROUPS/) - describes our various working groups +- [Working Group Processes](./WORKING-GROUP-PROCESSES/) - describes how working groups operate -- [Technical Oversight Committee](TECH-OVERSIGHT-COMMITTEE.md) - describes our +- [Technical Oversight Committee](./TECH-OVERSIGHT-COMMITTEE/) - describes our technical oversight committee -- [Steering Committee](STEERING-COMMITTEE.md) - describes our steering committee -- [Community Roles](ROLES.md) - describes the roles individuals can assume +- [Steering Committee](./STEERING-COMMITTEE/) - describes our steering committee +- [Community Roles](./ROLES/) - describes the roles individuals can assume within the Knative community -- [Reviewing and Merging Pull Requests](REVIEWING.md) - how we manage pull +- [Reviewing and Merging Pull Requests](./REVIEWING/) - how we manage pull requests ## Introduction Knative is a Kubernetes-based platform to build, deploy, and manage modern -serverless workloads. See [Knative docs](https://github.com/knative/docs) for +serverless workloads. See [Knative docs](../docs) for in-depth information about using Knative. ## Knative authors @@ -56,23 +56,23 @@ tools, platforms, languages, and products. By submitting a tutorial you can share your experience and help others who are solving similar problems. Community tutorials are stored in Markdown files on -[GitHub](./samples/README.md) where they can be reviewed and edited by the +[GitHub](../community/samples/) where they can be reviewed and edited by the community. Please submit a Pull Request to the community sample directory under the Knative -component that your tutorial highlights - [Serving](./samples/serving/), -[Eventing](./samples/eventing/), or [Build](./samples/build/). A reviewer will +component that your tutorial highlights - [Serving](../community/samples/serving/), +[Eventing](../community/samples/eventing/), or [Build](../community/samples/build/). A reviewer will be assigned to review your submission. They'll work with you to ensure your -submission meets the [style guide](DOCS-CONTRIBUTING.md), but it helps if you +submission meets the [style guide](./DOCS-CONTRIBUTING.md), but it helps if you follow it as you write your tutorial. ## Meetings and work groups Knative has public and recorded bi-weekly community meetings. -Each project has one or more [working groups](WORKING-GROUPS.md) driving the +Each project has one or more [working groups](./WORKING-GROUPS/) driving the project, and Knative as a single -[technical oversight community](TECH-OVERSIGHT-COMMITTEE.md) monitoring the +[technical oversight community](./TECH-OVERSIGHT-COMMITTEE/) monitoring the overall project. ## How can I help @@ -96,7 +96,7 @@ following resources are available for you: - [Knative Users](https://groups.google.com/forum/#!forum/knative-users) - [Knative Developers](https://groups.google.com/forum/#!forum/knative-dev) -For contributors to Knative, we also have [Knative Slack](SLACK-GUIDELINES.md). +For contributors to Knative, we also have [Knative Slack](./SLACK-GUIDELINES/). --- diff --git a/contributing/REVIEWING.md b/contributing/REVIEWING.md index bfc3a3c65..484802c0f 100644 --- a/contributing/REVIEWING.md +++ b/contributing/REVIEWING.md @@ -2,6 +2,7 @@ title: "Reviewing and merging Knative pull requests" linkTitle: "Pull request guidelines" weight: 60 +type: "docs" --- As a community, we believe in the value of code reviews for all contributions. @@ -9,7 +10,7 @@ Code reviews increase both the quality and readability of our code base, which in turn produces high quality software. This document provides guidelines for how the project's -[Members](ROLES.md#member) review issues and merge pull requests (PRs). +[Members](ROLES/#member) review issues and merge pull requests (PRs). - [Pull requests welcome](#pull-requests-welcome) - [Code of Conduct](#code-of-conduct) @@ -29,7 +30,7 @@ Please do not ever hesitate to ask a question or submit a PR. Reviewers are often the first points of contact between new members of the community and are important in shaping the community. We encourage reviewers to -read the [code of conduct](community/CODE-OF-CONDUCT.md) and to go above and +read the [code of conduct](CODE-OF-CONDUCT/) and to go above and beyond the code of conduct to promote a collaborative and respectful community. ## Code reviewers @@ -68,7 +69,7 @@ require a rebase are not considered active PRs. ### Holds -Any [Approver](ROLES.md#approver) who wants to review a PR but does not have +Any [Approver](ROLES/#approver) who wants to review a PR but does not have time immediately can put a hold on a PR. If you need more time, say so on the PR discussion and offer an ETA measured in single-digit days at most. Any PR that has a hold will not be merged until the person who requested the hold acks the @@ -76,10 +77,10 @@ review, withdraws their hold, or is overruled by a majority of approvers. ## Approvers -Merging of PRs is done by [Approvers](ROLES.md#approver). +Merging of PRs is done by [Approvers](ROLES/#approver). As is the case with many open source projects, becoming an Approver is based on -contributions to the project. See our [community roles](ROLES.md) document for +contributions to the project. See our [community roles](ROLES/) document for information on how this is done. ## Merging PRs diff --git a/contributing/ROLES.md b/contributing/ROLES.md index baffdf796..a61f02944 100644 --- a/contributing/ROLES.md +++ b/contributing/ROLES.md @@ -2,6 +2,7 @@ title: "Knative community roles" linkTitle: "Community roles" weight: 55 +type: "docs" --- This document describes the set of roles individuals may have within the Knative @@ -81,7 +82,7 @@ table describes:

Run their working group

Sponsored by the technical oversight committee as documented - here. + here. Write permissions on one or more repos allowing issues to be manipulated. Working Group @@ -214,13 +215,13 @@ approver in an OWNERS file: - Demonstrate sound technical judgement -- Responsible for project quality control via [code reviews](REVIEWING.md) +- Responsible for project quality control via [code reviews](REVIEWING/) - Focus on holistic acceptance of contribution such as dependencies with other features, backward / forward compatibility, API and flag definitions, etc - Expected to be responsive to review requests as per - [community expectations](REVIEWING.md) + [community expectations](REVIEWING/) - Mentor members and contributors @@ -259,7 +260,7 @@ Additional requirements for leads of a new working group: The following apply to the area / component for which one would be an owner. - Run their working group as explained in the - [Working Group Processes](WORKING-GROUP-PROCESSES.md). + [Working Group Processes](WORKING-GROUP-PROCESSES/). - Design/proposal approval authority over the area / component, though escalation to the technical oversight committee is possible. @@ -274,7 +275,7 @@ The following apply to the area / component for which one would be an owner. - Capable of directly applying lgtm + approve labels for any PR - Expected to respect OWNERS files approvals and use - [standard procedure for merging code](REVIEWING.md#merging-prs). + [standard procedure for merging code](REVIEWING/#merging-prs). - Expected to work to holistically maintain the health of the project through: diff --git a/contributing/SLACK-GUIDELINES.md b/contributing/SLACK-GUIDELINES.md index e701692b2..d373905ac 100644 --- a/contributing/SLACK-GUIDELINES.md +++ b/contributing/SLACK-GUIDELINES.md @@ -2,6 +2,7 @@ title: "Slack usage guidelines" linkTitle: "Slack guidelines" weight: 45 +type: "docs" --- Slack is the main communication platform for Knative outside of our mailing @@ -21,7 +22,7 @@ https://slack.knative.dev. ## Code of Conduct -The Knative [Code of Conduct](./CODE-OF-CONDUCT.md) applies throughout the +The Knative [Code of Conduct](./CODE-OF-CONDUCT/) applies throughout the project, and includes all communication mediums. ## Admins @@ -55,7 +56,7 @@ privately. Please reach out to the #slack-admins group with your request to create a new channel. -Channels are dedicated to [Working Groups](./WORKING-GROUPS.md), sub-projects, +Channels are dedicated to [Working Groups](./WORKING-GROUPS/), sub-projects, community topics, and related programs/projects. Channels are not: diff --git a/contributing/STEERING-COMMITTEE.md b/contributing/STEERING-COMMITTEE.md index d95987e97..3f643f448 100644 --- a/contributing/STEERING-COMMITTEE.md +++ b/contributing/STEERING-COMMITTEE.md @@ -2,6 +2,7 @@ title: "Knative steering committee" linkTitle: "Steering committee" weight: 40 +type: "docs" --- The Knative Steering Committee (SC) defines, evolves, and defends the vision, @@ -17,7 +18,7 @@ work-in-progress._ - Non-technical project oversight - Define policy for the creation and administration of community groups, - including [Working Groups](WORKING-GROUPS.md) and Committees. + including [Working Groups](WORKING-GROUPS/) and Committees. - Define and evolve project governance structures and policies, including project role assignment and contributor promotion. diff --git a/contributing/TECH-OVERSIGHT-COMMITTEE.md b/contributing/TECH-OVERSIGHT-COMMITTEE.md index 3c78c291b..6fb03d42e 100644 --- a/contributing/TECH-OVERSIGHT-COMMITTEE.md +++ b/contributing/TECH-OVERSIGHT-COMMITTEE.md @@ -2,6 +2,7 @@ title: "Knative technical oversight committee" linkTitle: "Technical oversight committee" weight: 35 +type: "docs" --- The Knative Technical Oversight Committee (TOC) is responsible for cross-cutting @@ -45,8 +46,8 @@ product and design decisions. community focus - Ensure the team adheres to our - [code of conduct](CONTRIBUTING.md#code-of-conduct) and respects our - [values](VALUES.md). + [code of conduct](CONTRIBUTING/#code-of-conduct) and respects our + [values](VALUES/). - Foster an environment for a healthy and happy community of developers and contributors. @@ -86,7 +87,7 @@ during the community feedback period at the end of each meeting. ## Committee Members The members of the TOC are shown below. Membership in the TOC is determined by -the [Steering committee](STEERING-COMMITTEE.md). +the [Steering committee](STEERING-COMMITTEE/). |   | Member | Company | Profile | | ------------------------------------------------------------- | ------------- | ------- | -------------------------------------------------- | diff --git a/contributing/VALUES.md b/contributing/VALUES.md index 568a7591a..0494e3840 100644 --- a/contributing/VALUES.md +++ b/contributing/VALUES.md @@ -2,6 +2,7 @@ title: "Knative team values" linkTitle: "Team values" weight: 50 +type: "docs" --- We want to make sure every member has a shared understanding of the goals and @@ -28,14 +29,14 @@ values we hold as a team: applicability of Knative). Empathize with our users. Focus on the specific issue at hand, and remember that we all care about the project, first and foremost. - - Emails to the [mailing lists](CONTRIBUTING.md#contributing-a-feature), + - Emails to the [mailing lists](CONTRIBUTING/#contributing-a-feature), document comments, or meetings are often better and higher bandwidth ways to communicate complex and nuanced design issues, as opposed to protracted heated live chats. - Be mindful of the terminology you are using, it may not be the same as someone else and cause misunderstanding. To promote clear and precise communication, define the terms you are using in context. - - See also the [Code of Conduct](CODE-OF-CONDUCT.md), which everyone must + - See also the [Code of Conduct](CODE-OF-CONDUCT/), which everyone must abide by. - Raising issues is great, suggesting solutions is even better diff --git a/contributing/WORKING-GROUP-PROCESSES.md b/contributing/WORKING-GROUP-PROCESSES.md index d14889e17..4bfdb6d7e 100644 --- a/contributing/WORKING-GROUP-PROCESSES.md +++ b/contributing/WORKING-GROUP-PROCESSES.md @@ -2,6 +2,7 @@ title: "Knative working group processes and guidelines" linkTitle: "Working group guidelines" weight: 30 +type: "docs" --- This document describes the processes we use to manage the Knative working @@ -100,7 +101,7 @@ working group: group to the meeting. - **Register the Working Group**. Go to - [WORKING-GROUPS.md](https://github.com/knative/serving/blob/master/community/WORKING-GROUPS.md) + [WORKING-GROUPS/](WORKING-GROUPS/) and add your working group name, the names of the leads, the working group charter, and a link to the meeting you created. @@ -132,7 +133,7 @@ representatives from multiple organizations as both leads and members. Working group leads must be Members of the Knative project (that is, have made multiple contributions to the project in the form of code, design, or documentation). -Please see the [Community Roles](ROLES.md) document for a description of a +Please see the [Community Roles](ROLES/) document for a description of a lead’s role and requirements. ## Running a working group @@ -188,7 +189,7 @@ Leads from all affected working groups generally work together and come to an agreeable conclusion. In all cases, remaining blocking issues can be raised to the -[technical oversight committee](TECH-OVERSIGHT-COMMITTEE.md) to help resolve the +[technical oversight committee](TECH-OVERSIGHT-COMMITTEE/) to help resolve the situation. To trigger an escalation, create an issue in the `knative/serving` repo and assign it to the **@knative/tech-oversight-committee** team. diff --git a/contributing/WORKING-GROUPS.md b/contributing/WORKING-GROUPS.md index f4ed629bd..3f3b9ff07 100644 --- a/contributing/WORKING-GROUPS.md +++ b/contributing/WORKING-GROUPS.md @@ -2,17 +2,17 @@ title: "Knative working group" linkTitle: "Join working groups" weight: 25 -type: +type: "docs" --- Most community activity is organized into _working groups_. -Working groups follow the [contributing](CONTRIBUTING.md) guidelines although +Working groups follow the [contributing](CONTRIBUTING/) guidelines although each of these groups may operate a little differently depending on their needs and workflow. When the need arises, a new working group can be created. See the -[working group processes](WORKING-GROUP-PROCESSES.md) for working group proposal +[working group processes](WORKING-GROUP-PROCESSES/) for working group proposal and creation procedures. The working groups generate design docs which are kept in a diff --git a/contributing/_index.md b/contributing/_index.md index 22529b021..088ae4413 100644 --- a/contributing/_index.md +++ b/contributing/_index.md @@ -12,7 +12,7 @@ aliases: Learn how to join the community of Knative contributors. -Also see our [Community page](community) for links to Knative chats, discussions, or Q&A. +Also see our [Community page](../community) for links to Knative chats, discussions, or Q&A. {{% readfile file="contributing/README.md" markdown="true" %}}