New Usage - Suggestion #361
Conversation
|
|
||
| A risk then tied to a **threat**, its **probability** and its **impacts**. | ||
| ## How to setup your own DSOMM | ||
| The DSOMM application can be run as a Docker image, an Amazon EC2 instance, or as a standalone Angular application using NodeJS. Please see [INSTALL.md](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel/blob/master/INSTALL.md) for further instructions. |
There was a problem hiding this comment.
there is no INSTALL.md in DSOMM / your PR
There was a problem hiding this comment.
Coming... But I thought I should get comments on the initiative first. (thanks for noticing. sorry that I forgot to specify that this was missing)
My plan was to gather the installations instructions from the other files, such as the README.
I do have a question about where the README.md and INSTALL.md should be. Today there is a README.md in the root folder, and a copy under assets. It makes sense to keep both in the root folder. But to render them, we also need them under assets, right?
Do you know if it is possible to create a github action that copies the readme (and possibly install.md) from root to assets on every push? (I have no experience creating github actions, though : )
There was a problem hiding this comment.
But to render them, we also need them under assets, right?
Yes
We could remove it and optimize the build to perform the copy from / to assets.
src/assets/Markdown Files/README.md
Outdated
| teamsImplemented: | ||
| Default: false | ||
| C: true | ||
| evidence: |
There was a problem hiding this comment.
it is teamsEvidence not evidence
There was a problem hiding this comment.
Good thing we're doing a review, then. I just copied this from the existing README. 😁
Talking about README, I will trim that file accordingly when we agree on what goes in the Usage file.
Hope you don't mind, but I feel this PR is more a request-for-comments than a request-for-merge. If you have a better way of collaborating on this, just let me know. My idea was to get some feedback if I was on the right track. Then continue step by step, INSTALL and then README coming up next. Looks like there is some redundancy in the About us as well that we should revise.
There was a problem hiding this comment.
Updated the two READMEs. Better?
|
Thank you, great work. Before we add more code, please make sure that tests are not failing /see #355 (comment) / |
Sure. 0x41head's comment in #355 didn't tell me anything new, unfortunately. So I'm still on the same spot. Any hints for understanding Angular test regime for components would be greatly appreciated. :) |
src/assets/Markdown Files/README.md
Outdated
| 3. Browse to <http://localhost:8080> (on macOS and Windows browse to <http://192.168.99.100:8080> if you are using docker-machine instead | ||
| of the native docker installation) | ||
|
|
||
| In case you would like to have perform an assessment for multiple teams, iterate from port 8080 to 8XXX, depending of the size of your team. | ||
| In case the application should be visible, but the "Implementation Level" shouldn't be changeable, consider the following code: | ||
| For customized DSOMM, take a look at https://github.com/wurstbrot/DevSecOps-MaturityModel-custom. In case you would like to have perform an assessment for multiple teams, iterate from port 8080 to 8XXX, depending of the size of your team. |
There was a problem hiding this comment.
In case you would like to have perform an assessment for multiple teams, iterate from port 8080 to 8XXX, depending of the size of your team.
We do not needs that any more as we have teamsImplemented.
| service docker start | ||
| docker run -d -p 80:80 wurstbrot/dsomm:latest | ||
| docker run -d -p 80:8080 wurstbrot/dsomm:latest |
|
@0x41head please review tests |
|
Thank you for approving the PR, @wurstbrot. I have not finished the INSTALL.md, yet, though. Do you want me to add that, and README adjustments to this PR, or create a new? |
create new |
I have created a new Usage, that focuses on the first time user, giving a brief overview.
I have split up the existing USAGE.md into /usage/maturity-level-0 and /usage/dimensions.
A demo can be seen at https://dsomm.pages.dev/usage/.
Any comments, approvals and improvements are welcomed :)