Skip to content

Commit

Permalink
Fix documentation links (#3659)
Browse files Browse the repository at this point in the history
  • Loading branch information
vi4m authored Sep 27, 2021
1 parent 0ee33da commit e29eb03
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/user/cloudsync.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ streams. Once that is done, one Cloud Provider object should be created and
configured properly in Ralph. To do that click Cloud providers from the Cloud
menu in Ralph.

![ralph-add-cloud-provider](/docs/img/ralph-add-cloud-provider.png "Add cloud provider")
![ralph-add-cloud-provider](./img/ralph-add-cloud-provider.png "Add cloud provider")

The configuration options available are:

Expand Down
6 changes: 3 additions & 3 deletions docs/user/custom_fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Possible options:

Example:

![custom-field-definition](/docs/img/custom-field-add.png "Example of custom field definition")
![custom-field-definition](./img/custom-field-add.png "Example of custom field definition")


## Attaching custom fields to objects
Expand All @@ -36,11 +36,11 @@ You could attach custom fields to any object type (if it was enabled by develope
Ralph's custom fields works pretty much the same as any other fields here. First type (part of) the name of the custom field into the `Key` field.


![custom-field-autocomplete](/docs/img/custom-field-autocomplete.png "Custom fields autocompletion")
![custom-field-autocomplete](./img/custom-field-autocomplete.png "Custom fields autocompletion")

Then select custom field of your choice in the autocomplete list. Notice that (for some types) value field might change it's type, for example to select list. Type or select desirable value and save the changes!

![custom-field-select-value](/docs/img/custom-field-select-value.png "Custom fields - value selection")
![custom-field-select-value](./img/custom-field-select-value.png "Custom fields - value selection")

> For any object, there could be at most one value for each custom field attached to it (in other words, you cannot have the same custom field attached to single object multiple times).
Expand Down
8 changes: 4 additions & 4 deletions docs/user/dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ Display graphs with quantity assets in each data centers.
### First dashboard
First of all we must create new dasboard object in Ralph by clicking in menu``Dashboards > Dashboards`` next click ``Add new dashboard`` to add new one.

![add-dashboard](/docs/img/dashboard-create-dasboard.png "Add dashboard")
![add-dashboard](./img/dashboard-create-dasboard.png "Add dashboard")


Next steps is create graph and configure it.
![add-first-graph](/docs/img/dashboard-create-graph-dc.png "Add first-graph")
![add-first-graph](./img/dashboard-create-graph-dc.png "Add first-graph")

The important field of form above is ``Params`` - this field accepted configuration of graph in JSON format. Keys ``labels``, ``series``, ``filters`` are required.
Below short description of these fields:
Expand All @@ -32,10 +32,10 @@ Below short description of these fields:
- ``target`` - contains keys: ``model``, ``filter``, ``value``; this options changes default view for clickable graph.

OK, after save go our new dashboard object. Now we can see item (``DC Capacity``) in ``Graphs`` fields - select them. After save go to ``Dashboards > Dashboards`` in list view click ``Link``.
![link-to-dashboard](/docs/img/dashboard-link.png "Link")
![link-to-dashboard](./img/dashboard-link.png "Link")

Final result:
![link-dashboard-final](/docs/img/dashboard-final-dc.png "Final dashboard")
![link-dashboard-final](./img/dashboard-final-dc.png "Final dashboard")

## Aggregating options

Expand Down
20 changes: 10 additions & 10 deletions docs/user/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In this tutorial we will go through:
Let's add a new Blade System which will act as a "Load balancer" system.
We want to have it visualized on the dc view, and assign some supports and licenses to it. To do this go to the `Data Center -> Hardware -> Add data center asset` menu.

![add-asset](/docs/img/quickstart-add-asset.png "Add asset")
![add-asset](./img/quickstart-add-asset.png "Add asset")

There are only 3 fields required to add a new server:

Expand All @@ -50,7 +50,7 @@ but we need to set-up them first.
`Model` field helps you organize many same-model devices. You can enter 'Model' field and start typing to search model from existing database models. But don't worry, if the list is empty. Adding model is easy without leaving the form. Just click on the `+` button inside the model field.
In the new window, just name this model, for example: "PowerEdge R620". Choose category from the "three-like" menu. Don't forget to set model type to "data center" - to use it in the data center module. You can add back office models as well - just switching `type` field.

![quickstart-model](/docs/img/quickstart-model.png "Model view")
![quickstart-model](./img/quickstart-model.png "Model view")

### Adding the service

Expand Down Expand Up @@ -87,7 +87,7 @@ Optional fields:

After adding new Service, add some environments below: `prod, test, dev`

![quickstart-add-service](/docs/img/quickstart-add-service.png "Add service")
![quickstart-add-service](./img/quickstart-add-service.png "Add service")

And that's it. This is one-time setup, so you can use user service-env all around the system.

Expand Down Expand Up @@ -125,7 +125,7 @@ In this tutorial you will learn how to manage graphical representation of your d

Let's go to the "Data Center visualization" menu item, and find your data center. You should see a new rack visible on the map.

![quickstart-dcview](/docs/img/quickstart-dcview.png "Data center view")
![quickstart-dcview](./img/quickstart-dcview.png "Data center view")

Click on 'Edit' function and try to

Expand All @@ -144,7 +144,7 @@ You can quickly add multiple new racks from dc visualization.
To do it, enter "Edit mode" and click on the view using "plus cursor" to add multiple racks.
You can edit each of them in separation, but remember to click "Save" button when you're done.

![quickstart-multiple-racks](/docs/img/quickstart-multiple-racks.png "Multiple racks at once view")
![quickstart-multiple-racks](./img/quickstart-multiple-racks.png "Multiple racks at once view")

### Accesing the DC inspector

Expand Down Expand Up @@ -186,7 +186,7 @@ Let's take the first route. Let's assume, we've bought 10-users license for micr

Click on the Add license to add one. You have to choose:

![quickstart-add-licence](/docs/img/quickstart-add-license.png "Quickstart add license")
![quickstart-add-licence](./img/quickstart-add-license.png "Quickstart add license")

* license type (per user, per core etc)
* software (e.g "Microsoft Office 2015") - click + to add new. In the next window, when you want to use this license everywhere (dc + back office) so choose "All"
Expand All @@ -205,14 +205,14 @@ If you marked your software as - both back office and data center enabled - you

If you type "10" licenses, you will use up all available licenses ("0 free").

![quickstart-assign-licence](/docs/img/quickstart-assign-license.png "Quickstart assign license")
![quickstart-assign-licence](./img/quickstart-assign-license.png "Quickstart assign license")


### Licenses reports

You can analyze in the details usage of licenses, by using one of our reports.

![quickstart-licenses-reports](/docs/img/quickstart-licences-reports.png "Quickstart licenses reports")
![quickstart-licenses-reports](./img/quickstart-licences-reports.png "Quickstart licenses reports")


## Vendor supports
Expand All @@ -225,7 +225,7 @@ Notable differences from the Licenses module:
* support can be only added to the Asset, not user(it's obvious, right? ;-))
* supports have additional 'Status' field to distinguish expired supports from active.

![quickstart-supports](/docs/img/quickstart-supports.png "Quickstart licenses reports")
![quickstart-supports](./img/quickstart-supports.png "Quickstart licenses reports")

As always, you can add as many attachments(for example pdf scans of support contracts), as you want.

Expand All @@ -240,7 +240,7 @@ To start stock-taking process:
* Check box in region admin panel (enables stock-taking for all assets belonging to users assigned to given region)

Now users will have option to check assigned items information in `My equipment` view:
![quickstart-stock-taking](/docs/img/stock-taking.png "Quickstart stock-taking")
![quickstart-stock-taking](./img/stock-taking.png "Quickstart stock-taking")

Once user confirms that they have specific asset inventory tags are added to asset record in database and are recorded in hardware history. Tags are configurable using settings file and warehouse admin. Self-stock-taking process does not conflict with regular stock-taking. When you are done you can simply un-check the boxes in admin panels.

Expand Down

0 comments on commit e29eb03

Please sign in to comment.