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

Remove obsolete documentation #342

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

michieldewilde
Copy link
Contributor

Description of the change

These fields don't exist in the provider at this time.

Checklist

Please make sure that the proposed change checks all the boxes below before requesting a review:

  • I have reviewed the guidelines for contributing to this repository.
  • The preview looks fine.
  • The tests pass.
  • The commit history is clean and meaningful.
  • The pull request is opened against the main branch.
  • The pull request is no longer marked as a draft.
  • You agree to license your contribution under the MIT license to Spacelift (not required for Spacelift employees).

If the proposed change is ready to be merged, please request a review from @spacelift-io/solutions-engineering. Someone will review and merge the pull request.

Spacelift employees should request reviews from the relevant engineers and are allowed to merge pull requests after they got at least one approval.

Thank you for your contribution! 🙇

@render
Copy link

render bot commented Sep 20, 2023

@@ -18,80 +18,6 @@ resource "spacelift_stack" "managed-stack" {
}
```

That's awesome. But can we put Terraform to good use and integrate it with resources from a completely different provider? Sure we can, and we have a good excuse, too. Stacks accessibility can be managed [by GitHub teams](../../concepts/stack/README.md#access-readers-and-writers-teams), so why don't we define some?
Copy link
Contributor

Choose a reason for hiding this comment

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

Don't we want to replace this with an up-to-date example instead of deleting it?

Without this, the "Taking it for a spin" section is underwhelming. 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we point to the terraform starter guide on GitHub?
I think that's the only hands-on terraform guide that we have that guides you through using the Spacelift provider.

Copy link
Contributor

Choose a reason for hiding this comment

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

Good idea. I hate duplicating content. 👍


!!! success
OK, so who wants to go back to clicking on things in the web GUI? Because you will likely need to do some clicking, too, [at least with your first stack](terraform-provider.md#proposed-workflow).
A more in depth guide that will guide you through creating multiple types of Spacelift resources through Terraform can be found at [the terraform-starter repository](https://github.com/spacelift-io/terraform-starter).
Copy link
Contributor

Choose a reason for hiding this comment

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

I would suggest a slight edit, other than that it looks good to me.

Suggested change
A more in depth guide that will guide you through creating multiple types of Spacelift resources through Terraform can be found at [the terraform-starter repository](https://github.com/spacelift-io/terraform-starter).
A more in-depth guide to creating multiple types of Spacelift resources with Terraform can be found at [the terraform-starter repository](https://github.com/spacelift-io/terraform-starter){: rel="nofollow"}.

@@ -6,7 +6,7 @@ What would you say if you could manage Spacelift resources - that is [stacks](..

Our Terraform provider is open source and its [README](https://github.com/spacelift-io/terraform-provider-spacelift) always contains the latest available documentation. It's also distributed as part of our [Docker runner image](../../integrations/docker.md#standard-runner-image) and available through our [own provider registry](terraform-provider.md#how-it-works). The purpose of this article isn't as much to document the provider itself but to show how it can be used to incorporate Spacelift resources into your infra-as-code.

So, without further ado, let's define a stack:
An example of a Spacelift stack being defined through Terraform:
Copy link
Contributor

Choose a reason for hiding this comment

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

Just a nit, this sentence comes across as a bit abrupt. The advantage of the "So, without further ado, ..." part was that it connected the example to the previous piece of text.

If you're going to reword it, I think it would need to be something like: "Here is an example showing how to define a Spacelift stack using Terraform".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants