Commit Graph

44 Commits

Author SHA1 Message Date
James O. D. Hunt
fdf0b9b64a docs: Document assisted PR review process
Add a section to the contributing guide explaining how we handle PRs
that are valuable but where the creator is either unable to progress
them, or is absent.

Fixes #43.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-06-22 10:42:51 +01:00
James O. D. Hunt
a8e6060a3f
Merge pull request #42 from annabellebertooch/election_date_change
docs: Changes Arch Committee election date
2018-06-21 09:52:56 +01:00
Anne Bertucio
355889919c docs: Changes Arch Committee election date
Changes the Architecture Committee elections from June 2018 to
September 2018 for 3 seats, and from December 2018 to
February 2019 for the remaining 2 seats.

Fixes #35.

Signed-off-by: Anne Bertucio <anne@openstack.org>
2018-06-19 14:30:34 -07:00
Graham Whaley
fafc7a700a
Merge pull request #37 from nitkon/patch-1
docs: Update "Users" part of README.md
2018-06-14 09:44:59 +01:00
Nitesh Konkar
f5fa733164 docs: Update "Users" part of README.md
Fixes: #36

Signed-off-by: Nitesh Konkar <niteshkonkar@in.ibm.com>
2018-06-13 18:13:22 +05:30
zhangwei_cs
ec7cac9574
Merge pull request #31 from jodh-intel/remove-owners-file-from-contrib-guide
docs: Remove mention of OWNERS files from contrib guide
2018-05-17 13:02:43 +08:00
Eric Ernst
8dbc74c609
Merge pull request #25 from jodh-intel/add-pr-review-guide
docs: Add PR review guide
2018-05-16 10:15:02 -07:00
zhangwei_cs
25445c5e1b
Merge pull request #29 from jodh-intel/clarify-fixes-requirement
docs: Rework patch format section in contributing guide
2018-05-16 16:08:09 +08:00
James O. D. Hunt
90be290bad docs: Add PR review guide
Add a document with tips on how to review a PR.

Fixes #24.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-27 17:37:34 +01:00
James O. D. Hunt
4b130ba220 docs: Rework patch format section in contributing guide
Overhauled the "Patch format" section in the contributing guide:

- Split the section into subsections.
- Simplified the general format example.
- Added a table of example subsystems.
- Explained that only the main change on a PR needs a "Fixes #XXX" comment.
- Added an example of a supplementary change.

Fixes #28.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-27 17:08:07 +01:00
James O. D. Hunt
5a91576b31 docs: Remove mention of OWNERS files from contrib guide
The Kata project doesn't use `OWNERS` files so rework the "Project
Maintainers" section of the contribution guide to explain who the
Approvers are and how the approval process works.

Fixes #30.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-26 08:51:20 +01:00
James O. D. Hunt
232e2cc870 docs: Outdent Project maintainers section
The "Project maintainers" section should be a top level section.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-04-25 15:32:25 +01:00
Eric Ernst
138fac8b52
Merge pull request #27 from grahamwhaley/20180410_vendoring
vendoring: update information around `prune`
2018-04-25 06:53:31 -07:00
Graham Whaley
fad72b77b6
Merge pull request #26 from annabellebertooch/patch-2
Creates a folder for weekly status drafts
2018-04-20 11:00:51 +01:00
Anne Bertucio
41ad3634f8 docs: Creates a folder for weekly status drafts
Creates a folder for drafts of weekly status reports for community
editing and provides a sample template for weekly reports.

Signed-off-by: Anne Bertucio <anne@openstack.org>
2018-04-17 14:44:10 -07:00
Graham whaley
f44599d3f1 vendoring: update information around prune
The new `dep` now automatically prunes, and has deprecated the
command line prune command.

Update the doc to reflect this. Also add a note that we like to
use the `non-go = true` option for prune as well if we can.

Fixes: #20

Signed-off-by: Graham whaley <graham.whaley@intel.com>
2018-04-10 11:53:21 +01:00
Graham Whaley
cc79dafeea
Merge pull request #22 from jodh-intel/add-license-file
docs: Add LICENSE file
2018-02-09 13:54:10 +00:00
Graham Whaley
de342d92b2
Merge pull request #19 from jodh-intel/arch-committee-members-as-list
docs: Specify Architecture Committee & Working Committee members as list
2018-02-09 13:42:25 +00:00
Graham Whaley
d4c2b21349
Merge pull request #17 from jodh-intel/docs-require-doc-team-signoff
CI: Require doc team signoff for doc changes
2018-02-09 13:41:39 +00:00
James O. D. Hunt
e53d98ccda docs: Add LICENSE file
Add the standard license file.

Fixes #21.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-02-06 10:14:45 +00:00
James O. D. Hunt
6d7b2312a4 docs: Specify Architecture & Working Committee members as lists
For clarity, list all members of the Architecture Committee and the
Working Committee as lists, with appropriate links.

Fixes #18.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-26 15:38:26 +00:00
James O. D. Hunt
99bea8e9a7
Merge pull request #15 from sboeuf/add_vendoring_docs
docs: Explain vendoring with dep tool
2018-01-25 09:01:08 +00:00
Sebastien Boeuf
581f72733c docs: Explain vendoring with dep tool
This commit introduces some new documentation about how to vendor
when using dep tool. All this documentation is gathered in a new
file called VENDORING.md

Fixes #14

Signed-off-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
2018-01-24 10:16:18 -08:00
James O. D. Hunt
ca09d1b344 CI: Require doc team signoff for doc changes
Require an additional approval from a `documentation` team member for
PRs containing documentation changes.

Fixes #16.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-24 12:13:50 +00:00
James O. D. Hunt
d83ea6cf41
Merge pull request #11 from jodh-intel/ref-contrib-doc
Move Developer section and reference the contributing guide
2018-01-19 07:54:30 +00:00
James O. D. Hunt
9ab510d417 docs: Use Oxford Comma in Governance wording
Based on review feedback, updated the Governance section slightly to use
an Oxford Comma before the last list item.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-18 09:42:18 +00:00
James O. D. Hunt
efa52e13eb docs: Add contributors section to README
Added a new Contributors section that directs the reader to the
contributing guide.

Fixes #10.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-18 09:39:57 +00:00
James O. D. Hunt
5dcb2e7572
Merge pull request #13 from jodh-intel/add-pullapprove-config
CI: Add pullapprove config
2018-01-16 13:58:23 +00:00
James O. D. Hunt
0e232f1b00 CI: Add pullapprove config
Add a Pullapprove config file to require 2 ack's for all PRs.

Fixes #12.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-16 11:44:24 +00:00
James O. D. Hunt
00b886bfbb docs: Move developer info to Governance section in README
Close reading shows that the Developer section should belong under the
Governance section as the former discusses governance.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-16 08:49:23 +00:00
James O. D. Hunt
133a8e867e
Merge pull request #9 from jodh-intel/add-central-contributing-doc
docs: Add central contributing doc
2018-01-16 08:11:42 +00:00
James O. D. Hunt
c53875ed8f docs: Add central contributing doc
This doc will be referenced by all the other Kata Containers
repositories.

Fixes #5.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-15 09:22:55 +00:00
James O. D. Hunt
2407245061
Merge pull request #8 from jodh-intel/add-code-of-conduct-doc
docs: Added CoC doc.
2018-01-11 16:31:17 +00:00
James O. D. Hunt
0c71a6ced4 docs: Added CoC doc.
Added that standard code of conduct document.

Fixes #7.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2018-01-11 14:32:00 +00:00
James O. D. Hunt
e7625fb116
Merge pull request #4 from grahamwhaley/20171221_typos
README: Minor fixups
2017-12-22 15:16:19 +00:00
Graham Whaley
845ece3e37 README: Minor fixups
Fix up a few typos and format slips.
Add the link for the 'four opens'.
Reword who can vote on committee members from 'anyone who has merged code'
(which would only be maintainers?) to 'anyone who has had code merged'
(which would be all contributors), which I believe is the intent.

Signed-off-by: Graham Whaley <graham.whaley@intel.com>
2017-12-21 10:56:38 +00:00
Xu Wang
e65bcc3a7c
Merge pull request #3 from jodh-intel/add-getting-started-info
Add getting started info
2017-12-21 16:20:42 +08:00
James O. D. Hunt
a3afd525f0 doc: Add Users section with install details
Add a new "Users" section with pointers off to installation details for
Clear Containers and runV.

Fixes #2.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2017-12-20 19:01:17 +00:00
James O. D. Hunt
ae2fd82edb doc: Add Developers section
Added a new "Developers" section and moved the existing "Contributor"
and "Maintainer" sections below it.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2017-12-20 17:45:11 +00:00
James O. D. Hunt
6827a79c52 doc: Add project links to README
Add in links to the Clear Containers and runv projects.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2017-12-20 17:43:33 +00:00
James O. D. Hunt
50fb0a562e doc: Add TOC to README
Add a table of contents to the README to make navigation easier.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
2017-12-20 17:39:10 +00:00
Jonathan Bryce
df4462b492
Merge pull request #1 from lsell/master
Creating community README
2017-12-04 19:32:34 -06:00
Lauren Sell
89f6ea3b00
Creating community README
Creating community README with basic governance outline and project overview
2017-12-04 19:30:57 -06:00
Jonathan Bryce
473af46110
Initial commit 2017-12-04 19:05:11 -06:00