aws-quickstart / quickstart-cisco-meraki-sd-wan-vmx

AWS Quick Start Team
Apache License 2.0
11 stars 16 forks source link

Documentation Update #2

Closed simarbir closed 2 years ago

simarbir commented 2 years ago

Description of changes: Documentation update

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

simarbir commented 2 years ago

@sshvans - quick question about generating the parameter table, I've added the parameter labels and groups for the entrypoint templates but when I generate the ascii docs locally, I am not able to see the parameter table. I am using the following command to generate the docs asciidoctor --base-dir docs/ --backend=html5 -o ../docs/index.html -w --doctype=book -a toc2 docs/boilerplate/index.adoc. Am I missing something or anything else required? thanks

sshvans commented 2 years ago

@sshvans - quick question about generating the parameter table, I've added the parameter labels and groups for the entrypoint templates but when I generate the ascii docs locally, I am not able to see the parameter table. I am using the following command to generate the docs asciidoctor --base-dir docs/ --backend=html5 -o ../docs/index.html -w --doctype=book -a toc2 docs/boilerplate/index.adoc. Am I missing something or anything else required? thanks

@simarbir The command you mentioned is to generate the doc without parameter table. If you would like to create guide with parameter table, you can use python3 docs/boilerplate/.utils/generate_parameter_tables.py && asciidoctor --base-dir docs/ --backend=html5 -o ../docs/index.html -w --doctype=book -a toc2 -a production_build docs/boilerplate/index.adoc -v

mufaddalq commented 2 years ago

@sshvans - quick question about generating the parameter table, I've added the parameter labels and groups for the entrypoint templates but when I generate the ascii docs locally, I am not able to see the parameter table. I am using the following command to generate the docs asciidoctor --base-dir docs/ --backend=html5 -o ../docs/index.html -w --doctype=book -a toc2 docs/boilerplate/index.adoc. Am I missing something or anything else required? thanks

@simarbir The command you mentioned is to generate the doc without parameter table. If you would like to create guide with parameter table, you can use python3 docs/boilerplate/.utils/generate_parameter_tables.py && asciidoctor --base-dir docs/ --backend=html5 -o ../docs/index.html -w --doctype=book -a toc2 -a production_build docs/boilerplate/index.adoc -v

@simarbir : Does this command fix the parameter table issue? Please update with latest.

simarbir commented 2 years ago

@sshvans - quick question about generating the parameter table, I've added the parameter labels and groups for the entrypoint templates but when I generate the ascii docs locally, I am not able to see the parameter table. I am using the following command to generate the docs asciidoctor --base-dir docs/ --backend=html5 -o ../docs/index.html -w --doctype=book -a toc2 docs/boilerplate/index.adoc. Am I missing something or anything else required? thanks

@simarbir The command you mentioned is to generate the doc without parameter table. If you would like to create guide with parameter table, you can use python3 docs/boilerplate/.utils/generate_parameter_tables.py && asciidoctor --base-dir docs/ --backend=html5 -o ../docs/index.html -w --doctype=book -a toc2 -a production_build docs/boilerplate/index.adoc -v

@simarbir : Does this command fix the parameter table issue? Please update with latest.

@mufaddalq - Yep, the command @sshvans had shared fixes the parameter table issue. I can generate the table now. I don't think I need to commit anything new though? since the parameter table would be dynamically generated based on the above command.

sshvans commented 2 years ago

@simarbir Can you resolve the conflicts so that I can merge this PR to develop branch?

simarbir commented 2 years ago

@simarbir Can you resolve the conflicts so that I can merge this PR to develop branch?

@sshvans done, the merge conflicts have been resolved.