search

containernetworking / cni.dev

CNI website
https://cni.dev
Apache License 2.0
48 stars 55 forks source link

First pass at bringing documentation in from CNI project. #17

Closed nate-double-u closed 3 years ago

nate-double-u commented 4 years ago

Before I go too far down this path, I wanted to confirm that what I'm bringing in are the correct documents that need to be surfaced from the https://github.com/containernetworking/cni repo, and that the CNI repo's documents do indeed need to be versioned (or is it just Plugins docs that need versioning).

nate-double-u commented 4 years ago

Deploy preview: https://deploy-preview-17--cni.netlify.app/ (please forgive the broken and ugly, this is a WIP)

nate-double-u commented 4 years ago

Breaking out the questions:

  1. Does the CNI project documentation need to be versioned?
nate-double-u commented 4 years ago

Here is the documents hierarchy:

content/docs/cni/0.8.0

├── code-of-conduct.md
├── contributing.md
├── conventions.md
├── dco.md
├── documentation
│   ├── cnitool.md
│   └── spec-upgrades.md
├── governance.md
├── releasing.md
├── roadmap.md
└── spec.md

Question 2: Are these all the files that need to be migrated from the CNI project?

nate-double-u commented 4 years ago

Some sample pages (since the nav is currently broken)

nate-double-u commented 4 years ago

Inviting @celestehorgan to review.

nate-double-u commented 4 years ago

Breaking out the questions:

1. Does the CNI project documentation need to be versioned?

The only CNI docs that need to be versioned are the spec.md and conventions.md files.1

nate-double-u commented 4 years ago

Question 2: Are these all the files that need to be migrated from the CNI project?

We can remove the releasing.md file, all other files are fine to be here, no other files missing.1

nate-double-u commented 3 years ago

closing this PR as we'll need to go with a different versioning strategy.