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.

Sign up for GitHub

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

Jump to bottom

Refactor and update the docs, and settings of the repo for 1.0 #727

Closed
14 tasks done
metral opened this issue Aug 21, 2019 · 0 comments · Fixed by #736
Closed
14 tasks done

Refactor and update the docs, and settings of the repo for 1.0 #727

metral opened this issue Aug 21, 2019 · 0 comments · Fixed by #736
Assignees
@metral
Labels
area/docs Improvements or additions to documentation
Milestone
0.26

Comments

@metral
Copy link
Contributor

metral commented Aug 21, 2019 •
edited
Loading

For 1.0 we should refactor and update the various docs, details, and settings of this repo.

Here's a checklist recently done on pulumi/eks:

  • README:
    • Include table of contents
    • Include reference links for API docs, and examples
    • Include install instructions
    • Include quick examples
  • Add examples directory (e.g: Crosswalk docs, pulumi/eks/nodejs/eks/examples)
    • TypeScript
    • Python
  • Update CONTRIBUTING with copy/paste style commands, and helper scripts (if necessary)
  • Add Github Issue and Pull Request templates
  • Review / Update GitHub Project Description
  • Add Github Project Website URL (e.g: https://www.pulumi.com/docs/reference/clouds/kubernetes)
  • Add Github Tags
  • Review repo settings, PR checks and requirements etc.
@metral metral self-assigned this Aug 21, 2019
@lukehoban lukehoban added the area/docs Improvements or additions to documentation label Aug 21, 2019
@lukehoban lukehoban added this to the 0.26 milestone Aug 21, 2019
@metral metral mentioned this issue Aug 22, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@metral metral

Labels
area/docs Improvements or additions to documentation
Projects
None yet
Milestone
0.26
Development

Successfully merging a pull request may close this issue.

Refactor and update the docs of the repo for 1.0 pulumi/pulumi-kubernetes
2 participants
@lukehoban @metral