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

docs: Add README and getting started docs #6

Merged
merged 8 commits into from
Oct 24, 2023
Merged

docs: Add README and getting started docs #6

merged 8 commits into from
Oct 24, 2023

Conversation

alexluong
Copy link
Collaborator

No description provided.

@leggetter
Copy link
Collaborator

leggetter commented Oct 13, 2023

@alexluong - what's the relationship between the content in /docs/templates and /docs/guides?

And if I were to make suggested edits, which files should it be against? Is there a way to avoid the duplication?

@alexluong
Copy link
Collaborator Author

@alexluong - what's the relationship between the content in /docs/templates and /docs/guides?
And if I were to make suggested edits, which files should it be against? Is there a way to avoid the duplication?

@leggetter You want to edit /templates/guides and then run go generate to generate the docs/guides

the idea is docs/ folder should always be auto-generated so we should not edit the content there

Copy link
Collaborator

@leggetter leggetter left a comment

Choose a reason for hiding this comment

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

@alexluong - this gives a really good:

a) getting started guide for the provider
b) picture of what else is possible

I've made a bunch of suggested changes, but nothing that fundamentally changes the content.

Good stuff!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/guides/getting-started.md Outdated Show resolved Hide resolved
templates/guides/rules.md Outdated Show resolved Hide resolved
templates/guides/rules.md Outdated Show resolved Hide resolved
templates/guides/rules.md Outdated Show resolved Hide resolved
templates/guides/rules.md Outdated Show resolved Hide resolved
templates/guides/rules.md Show resolved Hide resolved
@leggetter leggetter merged commit 7a08ee6 into main Oct 24, 2023
14 checks passed
@leggetter leggetter deleted the docs branch October 24, 2023 10:19
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

2 participants