Update doc display content#300
Merged
GuentherJulian merged 8 commits intodevonfw-tutorials:mainfrom Aug 13, 2021
Merged
Conversation
GuentherJulian
requested changes
Aug 3, 2021
| 3. (Optional) Path to the current directory where the user is located (relative to the workspace directory). Only needed if the directory is changed within this step. | ||
| you need two parameters for this function. | ||
|
|
||
| Example: displayContent(1st parameter, 2nd parameter) |
Contributor
There was a problem hiding this comment.
Do you think we need this line here. We have an example after the parameter description. I think it is not needed to have such a line in each function
|
|
||
| Note: The title should never be empty and it is of type string. | ||
|
|
||
| 2nd parameter i.e. An array of json objects with files, content, or images to be rendered within the Katacoda step. The use for this function is to display an image and some descriptive text. No Katacoda syntax is allowed in the files or the content! |
Contributor
There was a problem hiding this comment.
JSON in capital letters
|
|
||
| #### Details | ||
| Available attributes in the json objects: | ||
| You can use 3 attributes in the json objects array in 2nd parameter: |
| 3. image: Path to an image to be displayed in the Katacoda step. | ||
| 2nd attribute i.e. "content": Plain text to be displayed in the Katacoda step. This Text should be following the formating of asciidoc files. | ||
|
|
||
| 3rd attribute i.e. "image": Path to an image to be displayed in the Katacoda step. |
Contributor
There was a problem hiding this comment.
Here you can mention that the image should be located in a subfolder of the playbook directory
|
|
||
| Example: displayContent(1st parameter, 2nd parameter) | ||
|
|
||
| 1st parameter i.e. The title of the step. |
Contributor
There was a problem hiding this comment.
I would prefer a list syntax or bullet points for the parameters as it was before. So it stands out better from the text
GuentherJulian
previously approved these changes
Aug 12, 2021
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.