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

At least reference the Azure examples #274

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Tejeev
Copy link

@Tejeev Tejeev commented Jan 1, 2021

No description provided.

Copy link
Contributor

@rawmind0 rawmind0 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR @Tejeev .

I think it would be better to include to quickstart examples links at README.md Provider examples section. May be makes sense to add an entry by platform supported by quickstart, what do you think??

Something like

Provider examples
-----------------

You can view some tf file examples, [here](examples).

Additional examples can be found at [rancher/quickstart](https://github.com/rancher/quickstart):
* [aws](https://github.com/rancher/quickstart/tree/master/aws)
* [azure](https://github.com/rancher/quickstart/tree/master/azure)
....

On Openstack you can use [terraform-openstack-rke](https://github.com/remche/terraform-openstack-rke) module.

@Tejeev
Copy link
Author

Tejeev commented Jan 11, 2021

@rawmind0 I like that better, though I know some folks like to reference the examples section if it exists. Should we even leave it in here if we do not use it?

@rawmind0
Copy link
Contributor

rawmind0 commented Feb 1, 2021

Should we even leave it in here if we do not use it?

@Tejeev , I don't think we should leave empty examples as examples/Azure , just reference internal and external examples from README.md

@Tejeev
Copy link
Author

Tejeev commented Feb 13, 2021

@rawmind0 yes, that is what I meant. I think we should just remove the examples section since we do not use it

@Tejeev
Copy link
Author

Tejeev commented Feb 13, 2021

I'll check it out and make a pr later

@rawmind0
Copy link
Contributor

@rawmind0 yes, that is what I meant. I think we should just remove the examples section since we do not use it

@Tejeev, i don't fully understand what you mean. Do you mean remove whole example section?? I think that examples are used as reference by users. In fact, there is a PR opened to update them, #272 .

@Tejeev
Copy link
Author

Tejeev commented Mar 10, 2021

Oh, I misunderstood and thought you weren't going to use the examples section at all and were saying we shouldn't leave empty sections. IIUC this is what you are saying and if so, I agree and we should close this:

  1. We keep examples section but no empty sections
  2. We add a detailed reference to the quickstart with different links for different platforms. This should cover all the users looking for examples that would be better served by a quickstart.
  3. We won't have one in both that isn't in synch or otherwise up to date

@rawmind0
Copy link
Contributor

Oh, I misunderstood and thought you weren't going to use the examples section at all and were saying we shouldn't leave empty sections. IIUC this is what you are saying and if so, I agree and we should close this:

  1. We keep examples section but no empty sections
  2. We add a detailed reference to the quickstart with different links for different platforms. This should cover all the users looking for examples that would be better served by a quickstart.
  3. We won't have one in both that isn't in synch or otherwise up to date

Yes, agreed with this.

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.

4 participants