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

Add prototype documentation site #514

Merged
merged 3 commits into from
Feb 27, 2020
Merged

Conversation

ahmetb
Copy link
Member

@ahmetb ahmetb commented Feb 27, 2020

  • Developed with Hugo, though the design is currently quite minimal
    as I am not focusing on those parts right now. Therefore, Hugo-specific
    parts are <40 lines.
  • imported User Guide (install docs still will live in the repo README)
  • imported Developer Guide and made some heavy editing, added new pages

I recommend we merge this as-is and continue iterating on it over time.

To try this patch out: cd site; hugo serve

/kind docs

Related issue: #509.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Feb 27, 2020
@k8s-ci-robot
Copy link
Contributor

@ahmetb: The label(s) kind/docs cannot be applied, because the repository doesn't have them

In response to this:

  • Developed with Hugo, though the design is currently quite minimal
    as I am not focusing on those parts right now. Therefore, Hugo-specific
    parts are <40 lines.
  • imported User Guide (install docs still will live in the repo README)
  • imported Developer Guide and made some heavy editing, added new pages

I recommend we merge this as-is and continue iterating on it over time.

To try this patch out: cd site; hugo serve

/kind docs

Related issue: #509.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

- developed with Hugo, though the design is currently quite minimal
  as I am not focusing on those parts right now
- imported User Guide (install docs still will live in the repo README)
- imported Developer Guide and made some heavy editing, added new pages

I recommend we merge this as-is and continue iterating on it over time.

To try this patch out: cd site; hugo serve

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 27, 2020
@codecov-io
Copy link

codecov-io commented Feb 27, 2020

Codecov Report

Merging #514 into master will increase coverage by 0.6%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master     #514     +/-   ##
=========================================
+ Coverage   58.51%   59.12%   +0.6%     
=========================================
  Files          22       23      +1     
  Lines         969     1003     +34     
=========================================
+ Hits          567      593     +26     
- Misses        346      350      +4     
- Partials       56       60      +4
Impacted Files Coverage Δ
internal/pathutil/pathutil.go 100% <0%> (ø) ⬆️
internal/info/info.go 100% <0%> (ø) ⬆️
internal/indexmigration/migration.go 65.21% <0%> (ø)
internal/environment/environment.go 89.74% <0%> (+1.86%) ⬆️

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 fb5343a...6f2690d. Read the comment docs.

@corneliusweig corneliusweig added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 27, 2020
Copy link
Contributor

@corneliusweig corneliusweig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great work! 🎉 🍾

I left a few comments. Let's do only this single round of review and then let's iterate on new PRs as suggested.

Some related points:

  • When serving locally with hugo serve, code blocks did not have a dark background. Can you check how it renders on your machine?

  • For easier navigation it would be nice to have links to the next/previous page of the documentation. Is that doable?

site/layouts/shortcodes/prompt.html Outdated Show resolved Hide resolved
site/content/docs/user-guide/setup/install.md Outdated Show resolved Hide resolved
site/content/docs/user-guide/quickstart.md Outdated Show resolved Hide resolved
site/content/docs/user-guide/setup/uninstall.md Outdated Show resolved Hide resolved
site/content/docs/developer-guide/develop/naming-guide.md Outdated Show resolved Hide resolved
site/content/docs/developer-guide/plugin-manifest.md Outdated Show resolved Hide resolved
files:
- from: "kubectl-restart-*/restart.sh"
to: "./restart.sh"
- from: "LICENSE"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't say anywhere that we require a license to be included and installed. Let's add something like

# make sure to always install your LICENSE file

EDIT Ah, I found that you added a not to the submitters checklist. So this comment is not super urgent, but maybe still helpful.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wontfix for now.

site/content/docs/developer-guide/plugin-manifest.md Outdated Show resolved Hide resolved
@corneliusweig
Copy link
Contributor

Btw, I also don't see this landing page or the title bar when serving locally:
small

@ahmetb
Copy link
Member Author

ahmetb commented Feb 27, 2020

Yeah it’s expected since it’s not in this PR. :)

ahmetb and others added 2 commits February 27, 2020 09:00
Code review suggestions.

Co-Authored-By: Cornelius Weig <22861411+corneliusweig@users.noreply.github.com>
Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
@ahmetb
Copy link
Member Author

ahmetb commented Feb 27, 2020

Did another pass, PTAL @corneliusweig.
I've already developed more on top of this so it's getting harder to rebase as we iterate more and more on this. Once we get this in, you can do another pass of docs if you like. Let's not debate too much over content for now.

@corneliusweig
Copy link
Contributor

This is pure gold! Thanks again for getting this done!
/lgtm
/approve
(I'll probably have to merge manually because of our travis problem)

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 27, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, corneliusweig

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [ahmetb,corneliusweig]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@corneliusweig corneliusweig merged commit c3b34c1 into kubernetes-sigs:master Feb 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants