Commit Graph

89 Commits

Author SHA1 Message Date
Aaron Crickenberger 6153db5bf6 generator: make subproject owners links useful
reduce the visual noise, and make the links go to githubs UI

so: https://raw.githubusercontent.com/org/repo/branch/path/to/OWNERS
becomes:
- link text: org/repo/path/to
- link target: https://github.com/org/repo/blob/branch/path/to/ORWNERS

note: this does assume/imply we don't need to model the complexity of
subprojects owning different branches... but, we haven't found a reason
to do so in 5 years, seems a safe assumption
2021-03-09 14:12:03 -05:00
Aaron Crickenberger 34684158e9 generator: allow github and raw urls in sigs.yaml 2021-03-09 14:12:03 -05:00
Aaron Crickenberger 7a3a9e4e57 generator: add githubURL, orgRepoPath funcs 2021-03-09 14:12:03 -05:00
Aaron Crickenberger 320c5f10d6 generator: add validation of subprojects
specifically:
- only sigs+committees can have subprojects
- subprojects need at least one owners entry
- owners should be raw github links

I think the last one could/should change, but:
- I'm about to auto-generate links assuming this format, so I want to
  verify I can assume all owners are in this format
- I am not quite sure if we should treat sigs.yaml as public api and
  give notice/deprecation for field changes
2021-03-09 14:12:03 -05:00
Aaron Crickenberger 6687a0892a generator: "make test" passes again
there's a lot of boilerplate that is now expected in sigs.yaml
2021-03-09 14:12:03 -05:00
Nikhita Raghunath 058e3c4b23 generator: support liaisons in sigs.yaml 2021-01-20 10:37:33 +05:30
Bob Killen 067c680f77
Replace master list with community group name in sig-list template 2020-12-21 14:44:14 -05:00
Jorge O. Castro d264b3ba98
Add hugo metadata to SIG list so we can index it on k8s.dev (#5066)
* Add hugo metadata to SIG list so we can index it on k8s.dev

Signed-off-by: Jorge O. Castro <jorgec@vmware.com>

* Run make generate to generate the proper file

Signed-off-by: Jorge O. Castro <jorgec@vmware.com>

* Move hugo block above the template header

Signed-off-by: Jorge O. Castro <jorgec@vmware.com>

* Update generator/list.tmpl

Co-authored-by: Bob Killen <killen.bob@gmail.com>

* Run make to generate final page

Signed-off-by: Jorge O. Castro <jorgec@vmware.com>

Co-authored-by: Bob Killen <killen.bob@gmail.com>
2020-12-21 06:12:25 -08:00
Nikhita Raghunath f2fefb5450 generator: update OWNERS to current list of reviewers 2020-01-23 13:48:21 +05:30
Lubomir I. Ivanov 0d52e7b449 generator/app: add means for sorted and de-duped OWNERS_ALIASES
- Add LeadershipGroup#Owners() which returns a sorted and de-duped
list of owners ([]Person) for this LeadershipGroup by combining
Chairs and TechnicalLeads
- The function is used in generator/aliases.tmpl
- Update OWNERS_ALIASES with the new results
2020-01-23 04:44:02 +02:00
Nikhita Raghunath 13ccf338c4 generator: remove company for emeritus_leads from templates 2019-10-05 09:33:54 +05:30
Nikhita Raghunath a0055b5063 generator: don't specify company for emeritus_leads
If we end up specifying the company for emeritus leads, we could end
up stale information. Moreover, we don't gain any specific value
from company info of emeritus leads.
2019-10-05 09:33:54 +05:30
Aaron Crickenberger c8f1173de0 Make subprojects linkable, move github teams under contacts
This commit only contains the generator changes for easier review

The bulleted list of subprojects makes it impossible to link someone to
specific info for a given subproject. Now, instead of linking someone to
sig-testing#subprojects and asking them to scroll, I link them directly
to sig-testing#kind.


While I was at this, I made the main SIG/WG/UG/Committee contact info
format match what is used for subprojects, specifically:
- display the slack channel name
- list github teams as part of contact info instead of in a table
- use - instead of * for bullets

I also removed subproject rendering from WGs, since WGs cannot own code,
and added a link to the governance definition of what a subproject is.
2019-08-08 12:54:14 -07:00
Nikhita Raghunath a33d5ffe23 generator: enable validation for sigs.yaml 2019-07-30 19:36:13 +05:30
Nikhita Raghunath 720b9e9682 generator: add emeritus leads to WG and UG template 2019-07-25 21:15:02 +05:30
Aaron Crickenberger e63cbfae86 Validate same github id has same name/compay 2019-05-06 11:45:46 -07:00
Aaron Crickenberger 2b74274adc Prototype validation of sigs.yaml
Demonstrating this could be done, not going to enforce it for now.

There are also a number of these conventions that could probably
just be auto-generated.
2019-05-03 11:20:04 -07:00
Aaron Crickenberger 89cde82503 Update generator to reformat sigs.yaml
The following formatting is enforced:
- Consistent identation of 2 spaces
- Keys are sorted by order of struct fields
- Lists are sorted by struct-dependent keys
- Comments are stripped

I had hopes of using yaml.Node to preserve comments, but found no
obvious way to marshal from struct to Node, meaning all data
manipulation had to be done against Nodes. This loses us all of the
benefits of using a struct: types, known fields, field order.

Given that there aren't many comments in sigs.yaml to begin with, I'm
erring on the side of dropping support for them.
2019-05-03 11:20:04 -07:00
Aaron Crickenberger b91b05da2e Upgrade to gopkg.in/yaml.v3
This gives us access to the yaml.Node type, which can be used to
preserve more formatting than v2 supported during round tripping
of YAML
2019-05-03 11:20:04 -07:00
Nikhita Raghunath 221c2ad6db Display label for user groups in the SIG list 2019-04-09 04:48:04 -07:00
Aaron Crickenberger 197d53c4c6 Update generator OWNERS
I reviewed PRs over the last year:
- nikhita has done consistent review on almost every change
  that touches this code, added a number of substantive
  changes herself, and is a contribex tech lead
- pruning grodrigues3 due to lack of activity in the past year
2019-03-20 16:08:13 -07:00
Kubernetes Prow Robot 5b01aef9cd
Merge pull request #3466 from nikhita/committee-subproject
Add subprojects for committees
2019-03-20 13:30:59 -07:00
Aaron Crickenberger 2e1518026b Make subproject contacts optional, nest in display 2019-03-20 11:00:17 -07:00
Aaron Crickenberger 63dcb38987 Add contact (slack, mailing_list, teams) to subprojects
Demonstrate by adding slack channels for sig-testing subprojects
that already have their own slack channels

Add a GitHub team related to conformance to sig-arch's conformance
definition subproject

GitHub teams as implemented now are very kubernetes-org centric,
I'm not trying to change that here, would suggest a followup
change to allow for the use of github teams in other orgs
(like kubernetes-sigs)
2019-03-20 10:55:36 -07:00
Nikhita Raghunath aa4e7887f0 generator: add subprojects for committees 2019-03-19 18:07:16 +05:30
Nikhita Raghunath 347f7d07d3 generator: add support for committees
Since committees can have private mailing lists, this commit
also adds a new field for specifying private mailing lists
in the "Contacts" section.
2019-03-15 18:13:12 +05:30
Kubernetes Prow Robot c2f4d5bd0f
Merge pull request #3359 from nikhita/ug-owners-aliases
Automatically update OWNERS_ALIASES for UGs
2019-03-14 12:26:23 -07:00
Daniel Holbach 9f6dc887a8 fix link to weekly meeting
Signed-off-by: Daniel Holbach <daniel@weave.works>
2019-03-14 15:35:24 +01:00
Nikhita Raghunath 1f4012bfb8 Fix links to sig creation/lifecycle doc 2019-03-12 11:35:35 +05:30
Nikhita Raghunath 18fd90b1d4 Automatically update OWNERS_ALIASES for UGs 2019-03-05 22:12:50 +05:30
Kubernetes Prow Robot 831197acad
Merge pull request #3298 from nikhita/user-groups-sigs-yaml
Add support for User Groups in sigs.yaml
2019-03-04 09:55:45 -08:00
Nikhita Raghunath 1816b3e406 Add support for User Groups in sigs.yaml 2019-02-26 04:08:40 +05:30
Nikhita Raghunath cdb651b335 generator: remove google groups note from all WG READMEs 2019-02-25 16:17:40 +05:30
Roy Lenferink 4396a8b7f3 Updated OWNERS files to include link to docs 2019-01-30 19:37:21 +01:00
Nikhita Raghunath 0905af3507 generator: add support for stakeholder SIGs for WGs 2019-01-16 23:17:44 +05:30
Mike Danese 0ec20e7e32 trim whitespace around sub-project descriptions
so block descriptions look the same as inline descriptions.
2018-11-02 11:37:02 -07:00
Nikhita Raghunath 180425beba generator: remove google groups note from all SIG READMEs 2018-08-30 19:40:26 +05:30
shavidissa fc9fe8b0c6
Removed the extra change
My bad. Not sure how that got in there. Corrected.
2018-08-20 23:29:48 +05:30
shavidissa 2fba899835
Update README.md 2018-08-20 23:24:01 +05:30
shavidissa d797f41017
Copy-edit pass
Updated minor issues in the .md file.
- Introduced working groups in the intro (the abbreviation was not introduced previously).
- Removed extra words (that).
- Added a missing comma.
2018-08-20 19:51:16 +05:30
Aaron Crickenberger 6525e3049f Remove google groups links from SIG readmes 2018-08-08 15:02:46 -07:00
Wong Heung Sang 6b2d8a02d2 Beautify 2018-06-24 13:41:34 +08:00
Christoph Blecker 8b2a2601fb
Add field to define a link to the SIG's charter 2018-06-14 10:26:39 -07:00
Travis Rhoden 920b0712ff Use singular form of DST
Daylight Saving Time (DST) is singular, not plural.
2018-05-25 16:08:41 -07:00
mahuihuang c85bd954c7 fix grammar mistake 2018-04-04 15:44:51 +08:00
Christoph Blecker e8ede0fad8
Update sig docs generator OWNERS 2018-03-19 13:16:54 -07:00
Christoph Blecker dd70a35476
Modify generator to support chairs/tech leads 2018-03-14 15:36:25 -07:00
Christoph Blecker 5c3b558292
Move vendor to root, add misspell util 2018-03-05 09:31:45 -08:00
Christoph Blecker d9b419fbff
Add ability to have custom content in OWNERS_ALIASES 2018-02-23 16:30:57 -08:00
caleb miles d1d8dba932
Makes WG template closer to SIG template
- Adds subprojects
2018-02-21 14:04:06 -08:00