Code Monkey home page Code Monkey logo

cloud-user-docs's Introduction

Development Setup

The markdown files in this repo are visualized using mkdocs-material. In the config.yaml you will find a list of all installed markdown extensions. You can find the documentation here.

Docker

Use the Environment which will also be used in production.

docker run -it -v "$(pwd):/srv_root/docs"  -p "8000:8000" --env ENABLED_HTMLPROOFER=True --entrypoint="mkdocs" podman pull quay.io/denbicloud/mkdocswebhook:3.3.0 serve -f /srv_root/docs/config.yml   --dev-addr 0.0.0.0:8000

Or turn off the HTML Proffer for faster startup:

docker run -it -v "$(pwd):/srv_root/docs"  -p "8000:8000" --env ENABLED_HTMLPROOFER=False --entrypoint="mkdocs" quay.io/denbicloud/mkdocswebhook:3.3.0 serve -f /srv_root/docs/config.yml   --dev-addr 0.0.0.0:8000

Local

Please install the libraries used in the production instance: https://github.com/deNBI/mkdocsWebhook/blob/master/Dockerfile#L4

For a quick start you can also use pip to install both mkdocs and mkdocs-material:

pip install mkdocs
pip install mkdocs-material
mkdocs serve -f config_local.yml

Text writing plugin for JetBrains IDEs

The Grazie Professional plugin can be used, to ease text editing of this repository. It allows you to utilize styleguides and gives you suggestions while writing. For the rephrazing and synonymization feature you need to enable the processing via Grazie Cloud.

cloud-user-docs's People

Contributors

alnf avatar amir-baleghi avatar asczyrba avatar awalende avatar be-el avatar bgruening avatar braunma avatar cnexcale avatar cschu avatar dweinholz avatar ekatchko avatar hexylena avatar jkrue avatar jpecar avatar lang-dkfz avatar maitai avatar mathisjak avatar matthiaskoenig avatar maximilianhanussek avatar mwittchen avatar mzur avatar naincykumariknoldus avatar nilshoffmann avatar pbelmann avatar qqmok avatar rombaum avatar sgiller avatar tdilger avatar vekngs avatar vktrrdk avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

cloud-user-docs's Issues

User Role Schema

We need a schema which describes the roles of different users (vo manager,facility manager etc)

Feedback (https://cloud.computational.bio.uni-giessen.de)

Hi all,
I tried the tutorial at the cloud in Giessen. There are some things different than described in the tutorial. This could be due to a new version of OpenCloud (but I could not find out which version is running).

Finally, we can launch our instances. We are still on network overview page. Click on the Launch Instance button (pink box on the picture in the last chapter)."

-> There is no pink box before. No image showing the instances information. It was difficult to find the launch instance button. It is located in
Compute -> Instances -> Launch Instance

To allow external access to your instance via SSH, you have to change the security group and allow SSH! Go to Project -> Compute -> Access & Security

-> This is located in Project -> Network -> Security Groups

Best Matthias

vault: wiki

Need to make clear that users have to be logged in before they can paste the url

adjust pr template

users should wait until tests have passed

cloud-user-docs:
add small detail that they should wait for checks

update mcdocswebhook

dockerfile pip to requirements.txt, mount it and install. dependabot config

also test on staging

Travis fails

Travis html-proofer fails at the moment because of two reasons:

  • Freiburg OpenStack Login page is not online right now.

  • Heidelberg OpenStack Login page can not be accessed from CI machine.

1st hand feedback from a user

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.

  • "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

  • "First of all, you should read our Security aspects in clouds page!" - Dead link!

de.NBI Cloud Sites

All de.NBI Cloud sites should provide URL and Support Email in the Cloud Center specific section.

  • Freiburg
  • Tübingen
  • Heidelberg
  • Bielefeld
  • Giessen

Test Windows X2GO

Test the (Windows only) Export key in OpenSSH format for X2GO and X2GO connect section here

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.