Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move docs to ko.build #749

Merged
merged 8 commits into from
Sep 30, 2022
Merged

Move docs to ko.build #749

merged 8 commits into from
Sep 30, 2022

Conversation

imjasonh
Copy link
Member

@imjasonh imjasonh commented Jul 6, 2022

This copies content from README.md into separate docs in docs/, and uses mkdocs-material to generate a static site that's served from GitHub Pages, in the gh-pages branch.

A preview of this site served from https://github.com/imjasonh/ko.build is available at https://ko.build -- when this merges and is published I'll update the domain to point to this repo's site and archive that one. I'll also update our README.md to link to ko.build instead of duplicating content.

This also moves generated CLI docs from doc/ to docs/reference/, so we don't have to keep two copies in sync.

@imjasonh imjasonh requested a review from jonjohnsonjr July 6, 2022 13:03
@imjasonh imjasonh added this to the 0.12 milestone Jul 7, 2022
@codecov-commenter
Copy link

Codecov Report

Merging #749 (5e43025) into main (9139f45) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #749   +/-   ##
=======================================
  Coverage   51.19%   51.19%           
=======================================
  Files          44       44           
  Lines        3313     3313           
=======================================
  Hits         1696     1696           
  Misses       1404     1404           
  Partials      213      213           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9139f45...5e43025. Read the comment docs.

@imjasonh imjasonh marked this pull request as draft July 16, 2022 00:42
@imjasonh imjasonh removed this from the 0.12 milestone Jul 16, 2022
@imjasonh
Copy link
Member Author

Flipping this to Draft since we'll need a google GH org admin to set up the domain. This shouldn't block the 0.12 release.

@imjasonh imjasonh mentioned this pull request Aug 19, 2022
12 tasks
@imjasonh imjasonh marked this pull request as ready for review September 7, 2022 16:36
@imjasonh
Copy link
Member Author

imjasonh commented Sep 7, 2022

I'd like to get this merged so we can start running ko.build out of this repo instead of out of my personal repo.

This change also sets us up for the ko.build importpath, which will let us change the module name in 0.13 (e.g., go install ko.build@latest, import "ko.build/pkg/build", etc.

@imjasonh imjasonh merged commit e1b4ead into ko-build:main Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants