Skip to content

Commit

Permalink
some link tidying
Browse files Browse the repository at this point in the history
  • Loading branch information
pahjbo committed Mar 25, 2024
1 parent ddb0c95 commit 4c7c5db
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 38 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can find detailed theme instructions in the [mkdodcs material site](https://
pip install plantuml-markdown
```

https://github.com/neurobin/mdx_include - proper extension structure -> https://github.com/mikitex70/plantuml-markdown need that doing...
https://github.com/neurobin/mdx_include - proper extension structure -> https://github.com/mikitex70/plantuml-markdown need that doing... https://python-markdown.github.io/extensions/api/

## Running the website locally

Expand Down
4 changes: 2 additions & 2 deletions docs/Observer/Creating Proposals/adding-targets.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ to build an **Observation** for your proposal.

## Next Step

If you haven't already added a **Technical Goal** then please follow the guide [here](../adding-technical-goals).
If you haven't already added a **Technical Goal** then please follow the guide [here](adding-technical-goals.md).
If you have now added at least one **Target** and one **Technical Goal** to your proposal then please
follow the link to [**Building Observations**](../build-observation).
follow the link to [**Building Observations**](build-observation.md).
4 changes: 2 additions & 2 deletions docs/Observer/Creating Proposals/adding-technical-goals.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,6 @@ similar _Performance Parameters_ and/or _Spectral Windows_ without having to re-

## Next Step

If you haven't already added a **Target** then please follow the guide [here](../adding-targets).
If you haven't already added a **Target** then please follow the guide [here](adding-targets.md).
If you have now added at least one **Target** and one **Technical Goal** to your proposal then please follow the
link to [**Building Observations**](../build-observation).
link to [**Building Observations**](build-observation.md).
2 changes: 1 addition & 1 deletion docs/Observer/Creating Proposals/build-observation.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ you will also have to provide both **Scientific** and **Technical Justifications
it is likely more things will be added to the validation check in the future.

To see how to submit your proposal for review please follow the guide at
[**Submitting Proposals**](../../submitting-proposals)
[**Submitting Proposals**](../Submitting%20Proposals/index.md)
2 changes: 1 addition & 1 deletion docs/Observer/Creating Proposals/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## First, Login

If you haven't registered with and logged-in to Polaris please do so [now](tbc).
If you haven't registered with and logged-in to Polaris please do so [now](https://kilburn.jb.man.ac.uk/pst/gui/tool/).

## Click the **Create a new proposal** button

Expand Down
34 changes: 3 additions & 31 deletions docs/Observer/index.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,9 @@
---
title: Getting Started
description: Prerequisites, Installation, and Core Setup
categories: [Examples, Placeholders]
tags: [test, docs]
weight: 2
---
# Tools for Observers

## Prerequisites
Observers will mostly interact with Polaris via the [web based GUI](../prototype_information.md)

**To be confirmed**

## Installation
### For users
[Front end GUI](https://github.com/orppst/pst-gui)
There is also a [Front end CLI](https://github.com/orppst/pst-cli-app) under development which will offer a way of manipulating proposals via scripting.

[Front end CLI](https://github.com/orppst/pst-cli-app) - under development

### For Developers
[Overarching project](https://github.com/orppst)

[Back end API](https://github.com/orppst/pst-api-service)

## Setup

Go to the application URI (TBC) and register as a new user.
Then login with your new credentials where you will be asked to provide your organisation details by either selecting
from a list of existing institutions or supplying information about your organisation if not present in the list.

## Get started

Start by going to the **Creating Proposals** page.

_Please note that the screenshots in this guide were taken using an alpha version of Polaris so may contain
some stylistic and naming differences to the version you are using._


3 changes: 3 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ theme:
markdown_extensions:
- tables
- footnotes
# TODO add this once https://github.com/mikitex70/plantuml-markdown/pull/94 has been done
# - plantuml_markdown:
# server: https://www.plantuml.com/plantuml # PlantUML server, for remote rendering
- pymdownx.superfences:
custom_fences:
- name: mermaid
Expand Down

0 comments on commit 4c7c5db

Please sign in to comment.