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.

Sign up for GitHub

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

Jump to bottom

docs: fix a few issues and improve the generated reference docs #719

Merged
merged 1 commit into from
Apr 17, 2019
Merged

docs: fix a few issues and improve the generated reference docs #719

merged 1 commit into from
Apr 17, 2019

Conversation

edvald
Copy link
Collaborator

@edvald edvald commented Apr 16, 2019

  1. Some docs had not been updated recently due to a bug
  2. The Maven Container module type was not documented
  3. We were still using the old config style
  4. Added specific docs for each module type
  5. Moved schema handling and description to a plugin handler

eysi09
eysi09 approved these changes Apr 17, 2019
View reviewed changes
Copy link
Collaborator

@eysi09 eysi09 left a comment

Choose a reason for hiding this comment

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

LGTM. One comment on a console.log which I'm pretty sure is intentional.

garden-service/src/docs/config.ts
// Render provider docs
const providerDir = resolve(referenceDir, "providers")
for (const { name, schema } of providers) {
const path = resolve(providerDir, `${name}.md`)
console.log("->", path)
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is intentional, right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, it is.

@edvald edvald force-pushed the fix-reference-docs branch 2 times, most recently from 2465a45 to e3c1cf4 Compare April 17, 2019 09:57
@edvald
docs: fix a few issues and improve the generated reference docs
75c0dd5 
1. Some docs had not been updated recently due to a bug
2. The Maven Container module type was not documented
3. We were still using the old config style
4. Added specific docs for each module type
5. Moved schema handling and description to a plugin handler
@edvald edvald force-pushed the fix-reference-docs branch from e3c1cf4 to 75c0dd5 Compare April 17, 2019 09:59
@edvald edvald merged commit 1b5bef6 into master Apr 17, 2019
@edvald edvald deleted the fix-reference-docs branch April 17, 2019 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eysi09 eysi09 eysi09 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@edvald @eysi09