Add website reorganization proposal #21
Conversation
dfarrell07
added
documentation
dfarrell07
requested review from
mangelajo,
Oats87,
skitt and
tpantelis
as code owners
Propose reorganizing Getting Started and Operations sections into K8s-inspired Concepts, Tasks, Tutorials, and Reference sections. Signed-off-by: Daniel Farrell <[email protected]>
dfarrell07
force-pushed
the
website_reorg
branch
from
a8254e5 to
49ca97c
Compare
|
🤖 Created branch: z_pr21/dfarrell07/website_reorg |
|
I'm not sure if we should merge this yet, as I don't think actually implementing these website changes is a priority currently. |
| ├── development | ||
| │ ├── _index.md | ||
| │ ├── building-testing.md | ||
| │ ├── code-review.md | ||
| │ ├── release-process.md | ||
| │ ├── security.md | ||
| │ ├── shipyard | ||
| │ │ ├── _index.md | ||
| │ │ ├── first-time.md | ||
| │ │ └── advanced.md | ||
| │ └── website | ||
| │ ├── _index.md | ||
| │ └── style_guide.md |
There was a problem hiding this comment.
Following up the discussion on submariner-io/submariner-website#708 I think it's better to split this section (or nest it) since there are two types of documentation here:
- General guidelines (security, code review, contribution guide (which isn't listed here), website style guide).
- Specific operational guides (building and testing, releasing, everything shipyard, website contributions)
We could create either two sections on the top level, or nest on inside the other.
If we're following K8s docs example, the first category would be akin to "Contribute" and for the second one I dont see on a formal website but is akin to https://github.com/kubernetes/community/tree/master/contributors/devel
For example, we could have a structure such as:
| ├── development | |
| │ ├── _index.md | |
| │ ├── building-testing.md | |
| │ ├── code-review.md | |
| │ ├── release-process.md | |
| │ ├── security.md | |
| │ ├── shipyard | |
| │ │ ├── _index.md | |
| │ │ ├── first-time.md | |
| │ │ └── advanced.md | |
| │ └── website | |
| │ ├── _index.md | |
| │ └── style_guide.md | |
| ├── contributing | |
| │ ├── _index.md | |
| │ ├── concepts | |
| │ │ ├── code-review.md | |
| │ │ ├── contributing.md # https://submariner.io/development/contribution-guide/ | |
| │ │ └── security.md | |
| │ └── tasks | |
| │ ├── building-testing.md | |
| │ ├── release-process.md | |
| │ ├── shipyard | |
| │ │ ├── _index.md | |
| │ │ ├── first-time.md | |
| │ │ └── advanced.md | |
| │ └── website | |
| │ ├── _index.md | |
| │ └── style_guide.md |
|
@dfarrell07 - please open an epic for this proposal |
|
@maayanf24 ACK, will-do. And good catch, I also missed this on the list for 0.13 because there is no paired Epic Issue (because this PR is so old). |
|
Closing this as it's not a priority now or likely to be one soon, we can re-open if it becomes pressing. |
|
🤖 Closed branches: [z_pr21/dfarrell07/website_reorg] |
Propose reorganizing Getting Started and Operations sections into
K8s-inspired Concepts, Tasks, Tutorials, and Reference sections.
Signed-off-by: Daniel Farrell [email protected]