1st hand feedback from a user

awalende commented 5 years ago

A new user has used our cloud docs for a quick start. He gave a few aspects on improvements:

[ ] External Network is called "external", however wiki states "external_network"
[ ] "Click on Create Network (yellow box)": I don't see a yellow bow.
[x] "For further reading visit our Networking page" -> Dead link
[ ] Availability Zone in "Launch Instance" Form has default/highmem/gpu/maintenance/ssd as options, wiki only shows "nova"
[ ] The Submit-Button in "Allocate Floating IP"-Formula is called "Allocate IP", not "Associate IP": "Select the external_network in the pool field (red box) and click on the blue Associate IP Button". "Button" is written in lowercase
[x] "First of all, you should read our Security aspects in clouds page!" - Dead link!

hexylena commented 5 years ago

There are some nice dead link checkers. We use html-proofer in Galaxy documentation/training material.

pbelmann commented 5 years ago

There are some nice dead link checkers. We use html-proofer in Galaxy documentation/training material.

I agree. Need a continuous Integration integration (travis, circle ci,...) that checks it in combination with https://github.com/deNBI/mkdocsWebhook

pbelmann commented 5 years ago

links are now checked with awesome_bot

deNBI / cloud-user-docs