Skip to content

Commit

Permalink
Add intranet only note to help page
Browse files Browse the repository at this point in the history
  • Loading branch information
minottic committed Apr 13, 2022
1 parent 611a929 commit e8112b2
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/scicat-fe.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ jobs:
"ENVIRONMENT": $(jq -R -s < helm_configs/frontend/${{ needs.set_env.outputs.environment }}/environment.ts),
"STYLES": $(jq -R -s < helm_configs/frontend/styles.scss),
"LOGIN_COMPONENT": $(jq -R -s < helm_configs/frontend/login.component.html),
"HELP_COMPONENT": $(jq -R -s < helm_configs/frontend/help.component.html),
}
EOF
)
Expand Down
97 changes: 97 additions & 0 deletions helm_configs/frontend/help.component.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<p>
<mat-card class="help-card">
<mat-card-header>
<mat-card-title>Where is the official documentation?</mat-card-title>
</mat-card-header>
This is our <a href="https://scicatproject.github.io/" target="blank">documentation homepage</a>.
Following the documentation link (blue button at top left) you will find detailed information for
Users, Developers, Operators and Ingestors
</mat-card>
</p>


<p>
<mat-card class="help-card" *ngIf="gettingStarted">
<mat-card-header>
<mat-card-title>How to get started</mat-card-title>
</mat-card-header>
The
<a href="{{ gettingStarted }}" target="blank">Getting Started Guide</a>
(PSI intranet only) gives a brief description on how to get started
using the data catalog.
</mat-card>
</p>

<p>
<mat-card class="help-card" *ngIf="facility !== 'PSI'">
<mat-card-header>
<mat-card-title>Where is my data?</mat-card-title>
</mat-card-header>
Your data is stored and can be accessed by logging into {{ facility }} using
sftp to download a file. Alternatively, individual datafiles can be
downloaded by clicking on a datafiles tab for a given dataset, however this
is not recommended for large datasets
</mat-card>
</p>

<p>
<mat-card class="help-card" *ngIf="facility === 'PSI'">
<mat-card-header>
<mat-card-title>Where is my data?</mat-card-title>
</mat-card-header>
The data catalog keeps the *metadata* for your raw and derived datasets.
The actual files comprising the datasets are however stored outside the catalog.
Often the data will reside initially on disk.
The data catalog allows you to archive these files. In this way
the files on disk will be copied to tape and can be retrieved later to
a location of your choice. Here are the
<a href="https://scicatproject.github.io/documentation/Users/Jobs.html">details on the archive and retrieve workflows</a> see
</mat-card>
</p>

<p>
<mat-card class="help-card" *ngIf="shoppingCartEnabled">
<mat-card-header>
<mat-card-title>How can I publish a dataset?</mat-card-title>
</mat-card-header>
Select datasets in the dataset table and add to <b>Cart</b>. Once in
<b>Cart</b>, click <b>Publish</b> and follow instructions.
</mat-card>
</p>

<p>
<mat-card class="help-card" *ngIf="ingestManual">
<mat-card-header>
<mat-card-title>Ingest Manual</mat-card-title>
</mat-card-header>
The
<a href="{{ ingestManual }}" target="blank">Ingest Manual</a>
(PSI intranet only) provides detailed information on how to
make your data available to the catalog as well as archiving
and retrieval of datasets.
</mat-card>
</p>

<p>
<mat-card class="help-card">
<mat-card-header>
<mat-card-title>
Where are my proposals?
</mat-card-title>
</mat-card-header>
Once logged in, you can see your proposals at
<a routerLink="/proposals" routerLinkActive="active">Proposals</a>
</mat-card>
</p>

<p>
<mat-card class="help-card">
<mat-card-header>
<mat-card-title>
Where are my samples?
</mat-card-title>
</mat-card-header>
Once logged in, you can see your samples at
<a routerLink="/samples" routerLinkActive="active">Samples</a>
</mat-card>
</p>
4 changes: 4 additions & 0 deletions helm_configs/frontend/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ configMaps:
keycloak-icon-256px.svg: "{{ .Values.ciVars.KEYCLOAK_ICON }}"
styles.scss: "{{ .Values.ciVars.STYLES }}"
login.component.html: "{{ .Values.ciVars.LOGIN_COMPONENT }}"
help.component.html: "{{ .Values.ciVars.HELP_COMPONENT }}"

initContainers:
- name: install
Expand All @@ -67,6 +68,9 @@ volumeMounts:
- name: config-volume
mountPath: /usr/src/app/src/app/users/login/login.component.html
subPath: login.component.html
- name: config-volume
mountPath: /usr/src/app/src/app/help/help/help.component.html
subPath: help.component.html
- name: downloaddir
mountPath: /usr/src/app/src/assets/images/site.png
subPath: site.png
Expand Down

0 comments on commit e8112b2

Please sign in to comment.