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

Website: Backport breakup of expressions, resources, and modules pages #26953

Merged
merged 4 commits into from
Nov 18, 2020

Conversation

nfagerlund
Copy link
Member

This is just a backport of #26902 to the 0.14 branch.

Before doing the PR, I double-checked to see if there were any changes to the expressions, resources, or modules pages between commits 1c36729 (the base of this backport branch) and b06db96 (the base of the original branch). The only ones I saw were from non-version-specific improvements that hadn't gotten backported to 0.14, so we should be good to go.

This commit converts the previous URL for this content to a landing page, which
captures all of the previous in-page anchors and directs readers to the new home
for each section.
- Resource behavior gets its own page.
- Meta-arguments all get their own pages.
- Stuff about resource syntax itself gets a page.

In the process of breaking the meta-arguments out into their own pages, I
revised them (with the exception of `provider`) so that they apply to both
resources and modules.

Like with Expressions, this commit repurposes the old resources.html URL as a
landing page for old links.
This one is a lot like the previous two commits, but slightly more complex:

- Only adding one new meta-argument page, for `providers`; otherwise, it just
  re-uses the dual-purpose pages I made in the resources commit.

- About that `providers` argument: The stuff that was relevant to consumers of a
  module went in that meta-argument page, but there was also a huge deep dive on
  how the _author_ of a re-usable module should handle provider configurations
  in cases where inheriting the default providers isn't sufficient. THAT, I
  moved into a new page in the module development section. (For the consumer of
  a module, this should all be an implementation detail; the module README
  should tell you which aliased providers you need to configure and pass, and
  then you just do it, without worrying about proxy configuration blocks etc.)

- The "standard module structure" recommendations in the main module development
  page gets a page of its own, to make it more prominent and discoverable.

- Same deal with using the old URL as a landing page, at least for the main
  module calls page. It didn't seem necessary for the module development page.
...as well as to the standard module structure section in module development.
@codecov
Copy link

codecov bot commented Nov 18, 2020

Codecov Report

Merging #26953 (d7e6a11) into v0.14 (1c36729) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted Files Coverage Δ
terraform/evaluate.go 53.30% <0.00%> (+0.41%) ⬆️

@nfagerlund nfagerlund merged commit fb33d1e into v0.14 Nov 18, 2020
@nfagerlund nfagerlund deleted the nov20_backport_breakup_etc branch November 18, 2020 18:45
@ghost
Copy link

ghost commented Dec 19, 2020

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@ghost ghost locked as resolved and limited conversation to collaborators Dec 19, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants