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

Add Content Creation guide #116

Merged
merged 25 commits into from
Feb 12, 2021
Merged

Conversation

Trojan295
Copy link
Contributor

@Trojan295 Trojan295 commented Feb 9, 2021

Description

Changes proposed in this pull request:

  • Move jira-installation tutorial to docs/jira-installation/ directory,
  • Add manifests for confluence.install
  • Add Content Creation guide,
  • Change Interface JSON schema to support multiple input parameters (see cap.implementation.templating.jinja2.template).
  • Update Helm and CloudSQL runner input args JSON Schemas in their Interfaces

Testing

Go through the steps in docs/tutorial/content-creation/README.md

Related issue(s)

@Trojan295 Trojan295 force-pushed the SV-186-content-development-docs branch from 88562ef to 1ab959c Compare February 9, 2021 13:28
@Trojan295 Trojan295 force-pushed the SV-186-content-development-docs branch from 8cd2918 to 082902d Compare February 9, 2021 13:51
Copy link
Contributor

@platten platten left a comment

Choose a reason for hiding this comment

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

A few small formatting requests, but besides that looks good!

docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
Copy link

@jinoojain jinoojain left a comment

Choose a reason for hiding this comment

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

Overall this readme looks really good, I was able to follow along and understand the flow pretty easily.

The one overall recommendation I have would be to bold or italicize names like Types, Interfaces, Implementations, TypeInstances, InterfaceGroups, etc. throughout the doc so that it's easier for people to know that we are talking about the specific Voltron term and not just the generic word "type".

docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
docs/tutorial/content-creation/README.md Show resolved Hide resolved
docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
docs/tutorial/content-creation/README.md Outdated Show resolved Hide resolved
@Trojan295
Copy link
Contributor Author

Trojan295 commented Feb 12, 2021

@jinoojain, I added your suggestions and bolded the Voltron specific manifest names

@Trojan295 Trojan295 merged commit 5cf290e into master Feb 12, 2021
@Trojan295 Trojan295 deleted the SV-186-content-development-docs branch February 12, 2021 15:33
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.

3 participants