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

Refactor /docs/intro/concepts/programming-model #4580

Closed
5 tasks
isaac-pulumi opened this issue Nov 13, 2020 · 6 comments
Closed
5 tasks

Refactor /docs/intro/concepts/programming-model #4580

isaac-pulumi opened this issue Nov 13, 2020 · 6 comments
Assignees
Labels
kind/epic Large new features or investments resolution/fixed This issue was fixed

Comments

@isaac-pulumi
Copy link
Contributor

isaac-pulumi commented Nov 13, 2020

Problem

/docs/intro/concepts/programming-model has high traffic and high bounce. It is a very long doc that could be broken up into to improve discoverability, readability, and SEO.

Proposed solution

Pending doc/UX review:

@isaac-pulumi isaac-pulumi mentioned this issue Nov 15, 2020
14 tasks
@lukehoban
Copy link
Member

Is this the same issue tracked in #3249?

@joeduffy
Copy link
Member

I would also strongly suggest being deliberate about what is essential, informational, and reference material. We tend to intermingle these three freely and the ordering is a bit off. It would be better to lead in with the essential concepts and do a great job of explaining them succinctly, linking to further informational documentation for deeper dives.

For example, inputs and outputs, resources, configuration and secrets, etc, are critical to anybody doing Pulumi programming -- however, detailed documentation for every one of the available resource options, and/or shapes of dynamic provider APIs, certainly are not, and would be better put into detailed documentation pages for those topics, respectively.

@isaac-pulumi
Copy link
Contributor Author

@joeduffy this makes sense and appears to be in-line with some of the feedback in #3249 as @lukehoban points out.
That issue pointed out projects and stacks (current docs for those areas need work too).
#4585 is also relevant here as well.

@spara
Copy link
Contributor

spara commented Nov 17, 2020

Splitting up the docs and a several passes of rewrites are already completed. I need a week to make another pass and to move it from Google Docs to markdown. The tradeoff is that I need to defer the next Automation API blog post for a week to accomplish this.

@lukehoban
Copy link
Member

Splitting up the docs and a several passes of rewrites are already completed.

Note that if this work has happened offline, there have been 10 or so fixes to the programming-model page in the last week which we'll need to make sure to incorporate in.

@spara
Copy link
Contributor

spara commented Nov 17, 2020

I'll make sure they're included

@davidwrede davidwrede added kind/epic Large new features or investments resolution/fixed This issue was fixed labels Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/epic Large new features or investments resolution/fixed This issue was fixed
Projects
None yet
Development

No branches or pull requests

5 participants