Edit how-to "Adding VSCode support for diagrams (including preview)" #17

Closed philipwindecker closed 2 years ago

In GitLab by @jana.aydinbas on Oct 13, 2021, 12:24

Link: https://code.asam.net/common/asam-project-guide/-/blob/master/Wiki/docs/tool-specific/VSCode-Guide.adoc#user-content-adding-vscode-support-for-diagrams-including-preview

The how-to mixes up descriptive and instructive content and is hard to follow.

= My Amazing Document
:kroki-fetch-diagram:
This will store images by default in your document folder, however you may also set imagesdir to store them elsewhere:

The last sentence is probably not part of the example but the introduction for the next step.

The images are served over http:// and you must allow your preview to include data from unsafe sources. To do this open your command palette (ctrl+shift+P) and enter asciidoc preview security and choose Allow insecure content.

This only works with an open adoc file. The instructions do not explicitly say so. The setting seems to be independent from the file, though.

In GitLab by @philip.windecker on Oct 19, 2021, 09:29

marked this issue as related to #21

In GitLab by @philip.windecker on Oct 22, 2021, 07:14

assigned to @philip.windecker

In GitLab by @philip.windecker on Oct 22, 2021, 07:16

created branch 17-edit-how-to-adding-vscode-support-for-diagrams-including-preview to address this issue

In GitLab by @philip.windecker on Oct 22, 2021, 07:17

created branch 17-edit-how-to-adding-vscode-support-for-diagrams-including-preview to address this issue

In GitLab by @philip.windecker on Oct 22, 2021, 07:23

created branch 2nd_documentation_improvement to address this issue

In GitLab by @philip.windecker on Oct 22, 2021, 08:29

I created a new branch for these changes to not disturbed the currently ongoing review of the previous changes. The branch is https://code.asam.net/common/asam-project-guide/-/compare/master...2nd_documentation_improvement.

Changes made:

Added some more introductory text to the page
Separated the git infos and the diagrams tutorial into individual pages
Linked separated pages to the original page
Renamed guide to Overview
Cleaned up VSCode support for diagrams

In GitLab by @philip.windecker on Oct 22, 2021, 08:29

assigned to @jana.aydinbas and unassigned @philip.windecker

In GitLab by @philip.windecker on Oct 22, 2021, 08:30

@jana.aydinbas Please check if this is now more comprehensively structured. Thanks!

In GitLab by @jana.aydinbas on Oct 22, 2021, 10:57

Yes! Thank you, Philip!

In GitLab by @philip.windecker on Oct 22, 2021, 12:22

unassigned @jana.aydinbas

asam-ev / asam-project-guide

Edit how-to "Adding VSCode support for diagrams (including preview)" #17