diff --git a/README.md b/README.md index 22405e49f323e8175c06bc96dd8399d177719c1e..40c088070324c3bb583c357c966832e51bdae087 100644 --- a/README.md +++ b/README.md @@ -103,9 +103,17 @@ The application will run on `http://stackspin_proxy`. Add the following line to #### 4. Kubernetes access -The script needs you to have access to the Kubernetes cluster that runs -Stackspin. Point the `KUBECONFIG` environment variable to a kubectl config. -Attention points: +The `./run_app.sh` script needs to access the Kubernetes cluster that runs your Stackspin instance. If you followed the setup as above, you will have a YAML configuration file somewhere on your machine -- usually in the `clusters` directory of your Stackspin local repository -- called `kube_config_cluster.yml`. You can put that file anywhere you want (as long as Docker has read access to that directory). A common convention is to put it in the `~/.kube` directory. + +Assuming that your YAML file is in the above directory, run the following command (from the same terminal window you will use to run the script): + +``` +export KUBECONFIG=~/.kube/kube_config_cluster.yml +``` + +This way, when you run our install script from the same terminal window, it will use those configuration instructions, and you will be able to plug your local dashboard into your Stackspin instance. + +#### Troubleshooting points: - The kubeconfig will be mounted inside docker containers, so also make sure your Docker user can read it. @@ -117,9 +125,10 @@ Attention points: To recap, you now have: -- A running Stackspin _provisioning machine_ (the [Stackspin repository](https://open.greenhost.net/stackspin/stackspin) is installed and running on your computer) -- A running Stackspin cluster (a VPS that you successfully connected to from your computer) -- Implemented overrides for local dashboard development (by installing and running the [Dashboard Dev Overrides](https://open.greenhost.net/stackspin/dashboard-dev-overrides) repository, editing your `/etc/hosts` file, etc) +- All the software and configurations as described above +- A running Stackspin cluster (a VPS somewhere in The Cloud +- A KUBECONFIG environment that knows how to connect with your Stackspin cluster because it uses your `kube_config_cluster.yml` +- Overrides for local dashboard development (by installing and running the [Dashboard Dev Overrides](https://open.greenhost.net/stackspin/dashboard-dev-overrides) repository, editing your `/etc/hosts` file, etc) - A copy of the [Stackspin Dashboard repository](https://open.greenhost.net/stackspin/dashboard) on your device. That's a lot of work! Good job. @@ -128,7 +137,7 @@ That's a lot of work! Good job. Before you actually run the main script, `cd` into the `/frontend` directory and run`yarn install`. -This is not strictly necessary for development, as the script also builds and installs all the necessary stuff in the dashboard's docker container. But running `yarn install` locally will let your IDE enable all of its bells and whistles, as it will be expecting to find all the necessary in the `node_modules` folder. +This is not strictly necessary for development; the script already builds and installs all the necessary modules in the dashboard's docker container. But running `yarn install` locally will let your IDE enable all of its bells and whistles like linting, autocorrecting, intellisense etc. Without this step, your IDE will most probably complain it cannot find any modules to `import`, as there is no `node_modules` folder. ### Let's Run this App diff --git a/frontend/public/markdown/hedgedoc.md b/frontend/public/markdown/hedgedoc.md index aeef67f2d15023d7703947d1bce3bbb80b6e7eee..1b73bb122fbf9c4f68cbd1c9e4a2b8e3ef62f145 100644 --- a/frontend/public/markdown/hedgedoc.md +++ b/frontend/public/markdown/hedgedoc.md @@ -5,10 +5,16 @@ tileExcerpt: 'Quick collaborative writing pads, powered by Markdown.'  -This is help text for HedgeDoc. -This is more help text!!!!!!!! +## Introduction -yo -yo +[HedgeDoc](https://hedgedoc.org/) (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor. -yo +You can use it to easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers and they’re ready to go. + +## Signing in + +If this is the first time you're opening HedgeDoc, or if you have recently logged out of Stackspin, you will need to sign into Stackspin by clicking on the `Sign in` button on the top right of the screen. When asked to "Choose Method," select "Sign in via Stackspin." That's it! + +## Using HedgeDoc + +HedgeDoc is great for collaborative writing -- it's fast and easy to use, but for the more advanced features like styling it does require understanding the basics of Markdown. HedgeDoc provides a comprehensive list of features in, what do you know, a HedgeDoc file: https://demo.hedgedoc.org/features#. That is a great place to start to both understand the power of HedgeDoc, and to learn about Markdown in general. diff --git a/frontend/public/markdown/zulip.md b/frontend/public/markdown/zulip.md index ad16e75358cb8f52a8e703099ef05b4eee9c24f8..ef3c2b71338436509ca715fe87fe192aebdee00f 100644 --- a/frontend/public/markdown/zulip.md +++ b/frontend/public/markdown/zulip.md @@ -5,36 +5,13 @@ tileExcerpt: 'Team chat organized in topics and streams, with mobile and desktop  -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam vel felis rutrum, congue orci non, dictum -augue. In hac habitasse platea dictumst. Donec enim neque, vehicula vel consequat non, facilisis sed mauris. -Quisque a ligula sed velit gravida tristique. Mauris id nisi convallis, porttitor ante sed, blandit odio. In -consequat faucibus dolor, id aliquam quam. Fusce a faucibus tellus. Ut vitae ligula a ex consectetur rutrum -ultricies ac velit. Nullam in efficitur velit, efficitur euismod nulla. Mauris feugiat posuere libero, quis -accumsan ipsum mollis quis. Quisque at sapien lacus. Etiam aliquet, enim non pulvinar rhoncus, enim dolor -consectetur risus, a pharetra eros risus sed velit. Phasellus tristique feugiat ipsum, eget rhoncus arcu -ultrices nec. Nam et quam et sem tempor semper dictum nec ipsum. Aenean lobortis mauris non fringilla laoreet. -Sed fringilla vel justo nec pellentesque. +## Introduction -Quisque ac sem ipsum. Mauris interdum non risus sed gravida. Integer sit amet metus pharetra, tristique odio -a, rhoncus augue. Nam vitae neque in mi rutrum aliquam. Suspendisse vulputate efficitur venenatis. Proin -lobortis eros et velit commodo, sed sollicitudin sem maximus. Mauris ut tellus ipsum. Donec facilisis sed -ipsum vitae volutpat. Pellentesque viverra ex vel mi blandit, vel eleifend libero tincidunt. Vestibulum nec -felis congue, ultrices eros sit amet, maximus lacus. +[Zulip](https://zulip.com/) combines the immediacy of real-time chat with an email threading model. +With Zulip, you can catch up on important conversations while ignoring irrelevant ones. -Duis faucibus, tellus a commodo accumsan, felis mauris tincidunt ante, vel semper magna felis eget erat. Nam -vel odio non diam auctor pretium nec nec dui. Duis non dui ornare sem aliquet malesuada vitae sed odio. Etiam -porttitor ligula orci, in tristique ligula laoreet non. Nulla pulvinar mattis nisi volutpat hendrerit. Nunc -massa velit, feugiat vitae posuere sed, volutpat tristique ligula. Fusce a vulputate orci. Ut cursus mattis -malesuada. +## Signing in -Quisque ac sem ipsum. Mauris interdum non risus sed gravida. Integer sit amet metus pharetra, tristique odio -a, rhoncus augue. Nam vitae neque in mi rutrum aliquam. Suspendisse vulputate efficitur venenatis. Proin -lobortis eros et velit commodo, sed sollicitudin sem maximus. Mauris ut tellus ipsum. Donec facilisis sed -ipsum vitae volutpat. Pellentesque viverra ex vel mi blandit, vel eleifend libero tincidunt. Vestibulum nec -felis congue, ultrices eros sit amet, maximus lacus. +If this is the first time you're opening Zulip, or if you have recently logged out of Stackspin, you will need to sign into Stackspin by clicking on the `Log in with Stackspin` button on the top right of the screen. When asked to "Choose Method," select "Sign in via Stackspin." That's it! -Duis faucibus, tellus a commodo accumsan, felis mauris tincidunt ante, vel semper magna felis eget erat. Nam -vel odio non diam auctor pretium nec nec dui. Duis non dui ornare sem aliquet malesuada vitae sed odio. Etiam -porttitor ligula orci, in tristique ligula laoreet non. Nulla pulvinar mattis nisi volutpat hendrerit. Nunc -massa velit, feugiat vitae posuere sed, volutpat tristique ligula. Fusce a vulputate orci. Ut cursus mattis -malesuada. +## Using Zulip