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

Enhance docs; include volume and port mapping for Docker/WSL2 use cases [Fixes #31] #37

Merged
merged 4 commits into from
Oct 21, 2022

Conversation

julrichkieffer
Copy link
Contributor

Hi @dirkgroot

Here's the documentation update that includes the points triaged via #31 .

Copy link
Collaborator

@dirkgroot dirkgroot left a comment

Choose a reason for hiding this comment

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

Please add line breaks to make sure that each line is max 120 characters long (I'll add a .editorconfig later). This way, everyone can open the readme in any text editor without having to think about enabling line wrapping to conveniently read it.

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
```shell
installed> structurizr-site-generatr generate-site -w workspace.dsl

docker> docker run -it --rm -v c:/projects/c4:/var/model ghcr.io/avisi-cloud/structurizr-site-generatr:1.0.9 generate-site -w workspace.dsl
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
docker> docker run -it --rm -v c:/projects/c4:/var/model ghcr.io/avisi-cloud/structurizr-site-generatr:1.0.9 generate-site -w workspace.dsl
docker> docker run -it --rm -v c:/projects/c4:/var/model ghcr.io/avisi-cloud/structurizr-site-generatr:<version> generate-site -w workspace.dsl

README.md Outdated
```shell
installed> structurizr-site-generatr serve -w workspace.dsl

docker> docker run -it --rm -v c:/projects/c4:/var/model -p 8080:8080 ghcr.io/avisi-cloud/structurizr-site-generatr:1.0.9 serve -w workspace.dsl
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
docker> docker run -it --rm -v c:/projects/c4:/var/model -p 8080:8080 ghcr.io/avisi-cloud/structurizr-site-generatr:1.0.9 serve -w workspace.dsl
docker> docker run -it --rm -v c:/projects/c4:/var/model -p 8080:8080 ghcr.io/avisi-cloud/structurizr-site-generatr:<version> serve -w workspace.dsl

README.md Show resolved Hide resolved
@dirkgroot
Copy link
Collaborator

Thank you, this is a big improvement in the docs!

@julrichkieffer
Copy link
Contributor Author

My original pull request was compliant with out-the-box Prettier rules for markdown, that is no hard-coded line ends within paragraphs. However, as you specifically requested this, I've:

  • introduced hard-coded line ends within paragraphs so the Wrap Lines feature of editors isn't needed
  • introduced a basic .editorconfig with minimal settings. Note: max_line_length isn't widely supported, so I included reference links for your review
  • introducted a basic .prettierrc with only printWidth specified, which is the code formatting and quality approach I typically employ. However, as affecting your dev environment by applying standards and a Prettier dependency is outside my remit, I've left these activities for your attention.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@dirkgroot dirkgroot merged commit 57fe38e into avisi-cloud:main Oct 21, 2022
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.

None yet

2 participants