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

[WIP] Put contributing guide(s) on kubernetes.io #6102

Open
parispittman opened this Issue Oct 30, 2017 · 11 comments

Comments

@parispittman
Copy link
Contributor

parispittman commented Oct 30, 2017

This is a...

  • Feature Request
  • Bug Report

Problem:
All codebase and community contributor guides, documents, and relevant materials are scattered in the community github repo. A recent survey of 110 participants concluded a pattern that contributors (new and others) need a central point where other k8s documents are located for a smoother flow and easier to locate. Focus groups are also ongoing with current contributors about their experience.

Proposed Solution:
Put all updated and relevant contributor information that is located in the community repo in multiple files into a single displayed source on kubernetes.io. This would fall under "Contributing to the Kubernetes Docs" with the title "Contributing to the Kubernetes Codebase & Community"

Page to Update:
https://kubernetes.io/docs/home/

will also 'live' on the user journeys/personas piece for 'code contributor'

Additional Info

  • this will have a max of 8 sections (per @chenopis advice)
  • a Developers Guide will be one of those sections; this is being worked on by another team (RyanJ at RH is point)
  • @castrojo and I will run this through SIG-ContribX; join our bi-weekly discussions/mailing list
  • need docs for final edits
  • This is our raw document that we are working from -link. We will be trimming duplicate info, condensing, and adding information so that it's not 65 pages ( :) )
@guineveresaenger

This comment has been minimized.

Copy link

guineveresaenger commented Nov 16, 2017

Initial PR for starting point:
kubernetes/community#1409

@guineveresaenger guineveresaenger referenced this issue Nov 16, 2017

Closed

Umbrella issue for contributor's guide #1413

86 of 86 tasks complete
@guineveresaenger

This comment has been minimized.

Copy link

guineveresaenger commented Nov 16, 2017

Umbrella issue to flesh out the README and surrounding folder in PR above: kubernetes/community#1413

@chenopis chenopis added this to In Progress in User Journeys Project Nov 29, 2017

@fejta-bot

This comment has been minimized.

Copy link

fejta-bot commented Feb 15, 2018

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@justaugustus

This comment has been minimized.

Copy link
Member

justaugustus commented Feb 16, 2018

/remove-lifecycle stale

@heckj

This comment has been minimized.

Copy link
Member

heckj commented Mar 21, 2018

/lifecycle frozen

@mistyhacks

This comment has been minimized.

Copy link
Member

mistyhacks commented Aug 7, 2018

I believe this is fixed by #9510

@mistyhacks mistyhacks closed this Aug 7, 2018

@castrojo

This comment has been minimized.

Copy link
Contributor

castrojo commented Aug 7, 2018

/reopen
/cc @mrbobbytables

This issue is about the overall k8s contributor's guide, not the documentation contribution guide. We're close to finishing this, @mrbobbytables can you update this issue when we go live?

@k8s-ci-robot

This comment has been minimized.

Copy link

k8s-ci-robot commented Aug 7, 2018

@castrojo: you can't re-open an issue/PR unless you authored it or you are assigned to it.

In response to this:

/reopen
/cc @mrbobbytables

This issue is about the overall k8s contributor's guide, not the documentation contribution guide. We're close to finishing this, @mrbobbytables can you update this issue when we go live?

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.

@mistyhacks mistyhacks reopened this Aug 7, 2018

@mrbobbytables

This comment has been minimized.

Copy link
Member

mrbobbytables commented Aug 7, 2018

@castrojo sure thing! Shouldn't take too long once the cname record is in place.

@mrbobbytables

This comment has been minimized.

Copy link
Member

mrbobbytables commented Aug 8, 2018

The cname record is put in place, netlify configured and the site is now live! :)

@DanyC97

This comment has been minimized.

Copy link
Contributor

DanyC97 commented Feb 28, 2019

@mrbobbytables what is the url for site you mentioned above ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.