Add DEVELOPMENT.md #901
Add DEVELOPMENT.md #901
Conversation
This DEVELOPMENT.md will hopefully help folks ramp up and get started contributing to skaffold by describing the development process. After discussions with @r2d4 and @balopat we want to try out keeping the contributor/developer docs in markdown, while the user facing docs will continue to be in asciidoc. One of the reasons for this is that github will automatically link to the CONTRIBUTING.md and code of conduct, and so if we wrote this in ascii doc, we would _have_ to make the docs (and any references, links, etc.) that they contain work for both markdown view in github and ascii doctor view in the generated docs.
| make docs | ||
| ``` | ||
|
|
||
| And then open the generated docs/generated folder for `index.html` and `index.pdf`. |
There was a problem hiding this comment.
One part of this process I'm still not clear on: now that I've made doc changes, do I need to do anything special to publish those?
There was a problem hiding this comment.
no, docs automatically get published after changes are merged to master in the latest builds bucket on https://storage.googleapis.com/skaffold/builds/latest/docs/index.html. When we do a release it gets released into the given versions bucket: https://storage.googleapis.com/skaffold/releases/latest/docs/index.html
Currently we don't host these on anywhere else than GCS.
Codecov Report
@@ Coverage Diff @@
## master #901 +/- ##
=======================================
Coverage 38.27% 38.27%
=======================================
Files 56 56
Lines 2576 2576
=======================================
Hits 986 986
Misses 1476 1476
Partials 114 114Continue to review full report at Codecov.
|
DEVELOPMENT.md
Outdated
| @@ -120,6 +120,9 @@ make docs | |||
|
|
|||
| And then open the generated docs/generated folder for `index.html` and `index.pdf`. | |||
|
|
|||
| Once PRs with doc changes are merged, the docs will get automatically published to | |||
| [the public docs](https://storage.googleapis.com/skaffold/builds/latest/docs/index.html). | |||
There was a problem hiding this comment.
do we want to point out that there are separate builds and releases?
bobcatfish
force-pushed
the
development_md
branch
from
13a5ee5
to
dc19b63
Compare
This DEVELOPMENT.md will hopefully help folks ramp up and get started
contributing to skaffold by describing the development process.
After discussions with @r2d4 and @balopat we want to try out keeping the
contributor/developer docs in markdown, while the user facing docs will
continue to be in asciidoc. One of the reasons for this is that github
will automatically link to the CONTRIBUTING.md and code of conduct, and
so if we wrote this in ascii doc, we would have to make the docs (and
any references, links, etc.) that they contain work for both markdown
view in github and ascii doctor view in the generated docs.
Finally made this PR!!!! Sorry for the delay @r2d4 @balopat 😅