Skip to content

Commit 2b06904

Browse files
authored
Merge pull request #677 from anita-flegg/new-docs-wg
New docs wg
2 parents 6375882 + 977a1e4 commit 2b06904

File tree

5 files changed

+90
-77
lines changed

5 files changed

+90
-77
lines changed

toc/working-groups/WORKING-GROUPS.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ The current working groups are:
3838
- App Runtime Interfaces
3939
- App Runtime Platform
4040
- CF on K8s
41+
- Docs
4142
- Foundational Infrastructure
4243
- Paketo
4344
- Service Management
@@ -122,6 +123,24 @@ The GitHub repos this WG manages in the `cloudfoundry` GitHub organization are t
122123
| <img width="30px" src="https://github.com/gcapizzi.png"> | Giuseppe Capizzi | VMware | [@gcapizzi](https://github.com/gcapizzi) |
123124

124125

126+
## Docs
127+
128+
Mission: To document the Cloud Foundry user experience.
129+
130+
The GitHub repos this WG manages in the `cloudfoundry` GitHub organization are to be labeled with the `cff-wg-docs` topic.
131+
132+
| Artifact | Link |
133+
| -------------------------- | ---- |
134+
| Charter | [docs.md](./docs.md) |
135+
| Forum | [Video chat TBD]() |
136+
| Community Meeting Calendar | TBD |
137+
| Meeting Notes | [Google Doc TBD]() |
138+
| Slack Channel | [&#x23;cf-docs](https://cloudfoundry.slack.com/archives/C03B0T0D5) |
139+
140+
| &nbsp; | Leads | Company | Profile |
141+
| -------------------------------------------------------- | ---------------- | ------- | --------------------------------------- |
142+
| <img width="30px" src="https://github.com/anita-flegg.png"> | Anita Flegg | VMware | [@anita-flegg](https://github.com/anita-flegg) |
143+
125144
## Foundational Infrastructure
126145

127146
Mission: To provide infrastructure automation and core capabilities shared across CF projects, including identity management, credential management, and integrated data services.

toc/working-groups/app-runtime-interfaces.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -376,33 +376,6 @@ areas:
376376
- cloudfoundry/ykk
377377
- cloudfoundry/app-runtime-interfaces-infrastructure
378378

379-
- name: Docs
380-
approvers:
381-
- name: Chloe Hollingsworth
382-
github: cshollingsworth
383-
- name: Anita Flegg
384-
github: anita-flegg
385-
- name: Samia Nneji
386-
github: snneji
387-
- name: Ben Klein
388-
github: fifthposition
389-
- name: Ajayan Borys
390-
github: HenryBorys
391-
- name: Bob Graczyk
392-
github: bobbygeeze
393-
- name: Kelly OHara
394-
github: kohara88
395-
- name: Jason Andrew
396-
github: VMWare-JasonAndrew
397-
repositories:
398-
- cloudfoundry/docs-buildpacks
399-
- cloudfoundry/docs-cf-cli
400-
- cloudfoundry/docs-cloudfoundry-concepts
401-
- cloudfoundry/docs-dev-guide
402-
- cloudfoundry/docs-services
403-
- cloudfoundry/docs-dotnet-core-tutorial
404-
- cloudfoundry/app-runtime-interfaces-infrastructure
405-
406379
- name: Java Tools
407380
approvers:
408381
- name: Daniel Mikusa

toc/working-groups/app-runtime-platform.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -138,32 +138,6 @@ areas:
138138
- cloudfoundry/workpool
139139
- cloudfoundry/wg-app-platform-runtime-ci
140140

141-
- name: Docs
142-
approvers:
143-
- name: Max Hufnagel
144-
github: animatedmax
145-
- name: Chloe Hollingsworth
146-
github: cshollingsworth
147-
- name: Anita Flegg
148-
github: anita-flegg
149-
- name: Samia Nneji
150-
github: snneji
151-
- name: Ben Klein
152-
github: fifthposition
153-
- name: Ajayan Borys
154-
github: HenryBorys
155-
- name: Bob Graczyk
156-
github: bobbygeeze
157-
- name: Kelly OHara
158-
github: kohara88
159-
- name: Jason Andrew
160-
github: VMWare-JasonAndrew
161-
repositories:
162-
- cloudfoundry/docs-book-cloudfoundry
163-
- cloudfoundry/docs-cf-admin
164-
- cloudfoundry/docs-loggregator
165-
- cloudfoundry/docs-running-cf
166-
167141
- name: Garden Containers
168142
approvers:
169143
- name: Danail Branekov

toc/working-groups/docs.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Docs: Working Group Charter
2+
3+
## Mission
4+
5+
To document the Cloud Foundry user experience.
6+
7+
## Goals
8+
9+
- Make a plan for regular reviews and updates
10+
- Update and maintain READMEs for all docs repos
11+
- Update and maintain CF book repo/Table of Contents
12+
- Update and maintain contribution guidelines
13+
14+
15+
## Scope
16+
17+
- Merge and edit all doc changes
18+
- Update with the latest best practices for SEO
19+
- Remove out-dated information
20+
- Advise contributors on best practices
21+
22+
## Non-Goals
23+
24+
- Be responsible for component level documentation (e.g. Cloud Controller v3 docs).
25+
26+
## Roles & Technical Assets
27+
28+
```yaml
29+
name: Documentation
30+
execution_leads:
31+
- name: Anita Flegg
32+
github: anita-flegg
33+
technical_leads:
34+
- name: Anita Flegg
35+
github: anita-flegg
36+
bots: []
37+
areas:
38+
- name: Docs
39+
approvers:
40+
- name: Max Hufnagel
41+
github: animatedmax
42+
- name: Anita Flegg
43+
github: anita-flegg
44+
- name: Samia Nneji
45+
github: snneji
46+
- name: Ben Klein
47+
github: fifthposition
48+
- name: Ajayan Borys
49+
github: HenryBorys
50+
- name: Bob Graczyk
51+
github: bobbygeeze
52+
- name: Lora Boe
53+
github: blora1
54+
55+
repositories:
56+
- cloudfoundry/docs-book-cloudfoundry
57+
- cloudfoundry/docs-cf-admin
58+
- cloudfoundry/docs-loggregator
59+
- cloudfoundry/docs-running-cf
60+
- cloudfoundry/docs-bbr
61+
- cloudfoundry/docs-credhub
62+
- cloudfoundry/docs-uaa
63+
- cloudfoundry/docs-buildpacks
64+
- cloudfoundry/docs-cf-cli
65+
- cloudfoundry/docs-cloudfoundry-concepts
66+
- cloudfoundry/docs-dev-guide
67+
- cloudfoundry/docs-services
68+
- cloudfoundry/docs-credhub
69+
- cloudfoundry/docs-dotnet-core-tutorial
70+
- cloudfoundry/app-runtime-interfaces-infrastructure
71+
```

toc/working-groups/foundational-infrastructure.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -56,30 +56,6 @@ bots:
5656
- name: bbr-ci
5757
github: bbr-ci
5858
areas:
59-
- name: Docs
60-
approvers:
61-
- name: Chloe Hollingsworth
62-
github: cshollingsworth
63-
- name: Max Hufnagel
64-
github: animatedmax
65-
- name: Anita Flegg
66-
github: anita-flegg
67-
- name: Samia Nneji
68-
github: snneji
69-
- name: Ben Klein
70-
github: fifthposition
71-
- name: Ajayan Borys
72-
github: HenryBorys
73-
- name: Bob Graczyk
74-
github: bobbygeeze
75-
- name: Kelly OHara
76-
github: kohara88
77-
- name: Jason Andrew
78-
github: VMWare-JasonAndrew
79-
repositories:
80-
- cloudfoundry/docs-bbr
81-
- cloudfoundry/docs-credhub
82-
- cloudfoundry/docs-uaa
8359
- name: Credential Management (Credhub)
8460
approvers:
8561
- name: Peter Chen

0 commit comments

Comments
 (0)