Skip to content
Snippets Groups Projects
Commit dc36c95a authored by Anders Lindh Olsson's avatar Anders Lindh Olsson :8ball:
Browse files

Merge branch 'icshwi-9656_revise_texts_and_formatting' into 'develop' 

ICSHWI-9656: Improve phrasings and formatting

See merge request !199
parents 2d5a399a 66e8affa
No related branches found
No related tags found
4 merge requests!270Merging develop branch to master in order to create RC,!222Fixing missing time interval parameter for logs,!202Merging develop to master,!199ICSHWI-9656: Improve phrasings and formatting
Pipeline #114817 passed
Stage: dependencies
Stage: build
Stage: lint
Stage: documentation
Stage: test
Stage: package
Stage: deploy
Hide whitespace changes
Inline Side-by-side
src/views/about/AboutView.js
+ 1
− 6
View file @ dc36c95a
...@@ -25,12 +25,7 @@ export function AboutView() { ...@@ -25,12 +25,7 @@ export function AboutView() {
<Paper className={classes.paper}> <Paper className={classes.paper}>
<Typography variant="body1"> <Typography variant="body1">
This is the <Link href="https://confluence.esss.lu.se/x/CVGQFg" target="_blank" rel="noreferrer">final</Link> version of the deployment part of the CCDB ecosystem (working name CE deploy & monitor). It is a tool that manages IOCs on host machines, using Ansible to perform the necessary configuration management. This tool will set up IOC-hosts and deploy IOC(s) in a consistent manner, and will configure all necessary services towards this purpose. The tool also integrates with various other systems to enable monitoring of IOCs and hosts, and enables some limited remote execution features. Please note that this is a developmental version, and that This is the <Link href="https://confluence.esss.lu.se/x/CVGQFg" target="_blank" rel="noreferrer">deployment and monitoring</Link> parts of the IOC toolchain in the controls ecosystem (CE); working name &quot;CE deploy & monitor&quot;. It is a tool that manages IOCs on host machines, using Ansible to perform the necessary configuration management. This tool will set up IOC-hosts and deploy IOC(s) in a consistent manner, and will configure all necessary services towards this purpose. The tool also integrates with various other systems to enable monitoring of IOCs and hosts, and enables some limited remote execution features.
<ol>
<li>we do not guarantee data (about deployments) to persist</li>
<li>we offer only minimal support</li>
<li>users might be asked to make changes as we modify (for example) the expected IOC metadata format on a semi-short timeframe.</li>
</ol>
<p>Be aware that the tool does <b>not</b> set up your host (and OS) - this needs to be done in CSEntry.</p> <p>Be aware that the tool does <b>not</b> set up your host (and OS) - this needs to be done in CSEntry.</p>
......
src/views/help/HelpView.js
+ 5
− 5
View file @ dc36c95a
...@@ -25,11 +25,11 @@ export function HelpView() { ...@@ -25,11 +25,11 @@ export function HelpView() {
<h2>Help</h2> <h2>Help</h2>
<Paper className={classes.paper}> <Paper className={classes.paper}>
<Typography variant="body1"> <Typography variant="body1">
<p>Before you can deploy an IOC, <b>you need to</b>: <p>Before you can deploy an IOC, you need to:
<ul> <ul>
<li>have your IOC registered in <Link href="https://ccdb.esss.lu.se/" target="_blank" rel="noreferrer">CCDB</Link> (go <Link href="https://confluence.esss.lu.se/x/k41nFg" target="_blank" rel="noreferrer">here</Link> for help)</li> <li>have your IOC registered in <Link href="https://ccdb.esss.lu.se/" target="_blank" rel="noreferrer">CCDB</Link> (go <Link href="https://confluence.esss.lu.se/x/k41nFg" target="_blank" rel="noreferrer">here</Link> for help)</li>
<li>have an IOC host registered in <Link href="https://csentry.esss.lu.se/" target="_blank" rel="noreferrer">CSEntry</Link> (physical or virtual).</li> <li>have an IOC host registered in <Link href="https://csentry.esss.lu.se/" target="_blank" rel="noreferrer">CSEntry</Link></li>
<li>have your IOC in a ESS GitLab repository in the <Link href="https://gitlab.esss.lu.se/iocs" target="_blank" rel="noreferrer">iocs</Link> group (you can use <Link href="https://gitlab.esss.lu.se/ics-cookiecutter/cookiecutter-e3-ioc" target="_blank" rel="noreferrer">cookiecutter</Link> to create the repository, or you can create it by hand - you can find an example IOC repository <Link href="https://gitlab.esss.lu.se/ccce/dev/e3-ioc-ccce-example" target="_blank" rel="noreferrer">here</Link>)</li> <li>have your IOC in a ESS GitLab repository in the &quot;<Link href="https://gitlab.esss.lu.se/iocs" target="_blank" rel="noreferrer">iocs&#47;</Link>&quot; group (you can use <Link href="https://gitlab.esss.lu.se/ics-cookiecutter/cookiecutter-e3-ioc" target="_blank" rel="noreferrer">cookiecutter</Link> to create the repository, or you can create it by hand - you can find an example IOC repository <Link href="https://gitlab.esss.lu.se/ccce/dev/e3-ioc-ccce-example" target="_blank" rel="noreferrer">here</Link>)</li>
</ul> </ul>
Deployments shall be done on blank (formatted) machines set up with CSEntry - some configuration is done during OS installation. Deployments made on old hosts, or hosts which make use mixed deployment methods (e.g. with both manually and CE-deployed IOCs) are not supported by the CE team. Deployments shall be done on blank (formatted) machines set up with CSEntry - some configuration is done during OS installation. Deployments made on old hosts, or hosts which make use mixed deployment methods (e.g. with both manually and CE-deployed IOCs) are not supported by the CE team.
...@@ -39,7 +39,7 @@ export function HelpView() { ...@@ -39,7 +39,7 @@ export function HelpView() {
<p>If you need support, please visit the <Link href="https://ess-eric.slack.com/archives/C01V3R31EP2" target="_blank" rel="noreferrer">#ccce-ioc-deployment-beta</Link> channel on ESS&lsquo; Slack.</p> <p>If you need support, please visit the <Link href="https://ess-eric.slack.com/archives/C01V3R31EP2" target="_blank" rel="noreferrer">#ccce-ioc-deployment-beta</Link> channel on ESS&lsquo; Slack.</p>
<p>We also have a bug tracker and Known Issues page on <Link href="https://confluence.esss.lu.se/x/3fPIFQ" target="_blank" rel="noreferrer">Confluence</Link>, as well as a number of <Link href="https://confluence.esss.lu.se/x/CVGQFg" target="_blank" rel="noreferrer">help articles</Link>.</p> <p>We also have a <Link href="https://confluence.esss.lu.se/x/3fPIFQ" target="_blank" rel="noreferrer">bug and known issues page</Link>, as well as a number of <Link href="https://confluence.esss.lu.se/x/CVGQFg" target="_blank" rel="noreferrer">help articles</Link>.</p>
</Typography> </Typography>
</Paper> </Paper>
<h2>FAQ</h2> <h2>FAQ</h2>
...@@ -62,7 +62,7 @@ export function HelpView() { ...@@ -62,7 +62,7 @@ export function HelpView() {
<ul> <ul>
<li>In order to to register an IOC, it must be registered in CCDB.</li> <li>In order to to register an IOC, it must be registered in CCDB.</li>
<li>In order to deploy to a host, it needs to be configured as an IOC host in CSEntry.</li> <li>In order to deploy to a host, it needs to be configured as an IOC host in CSEntry.</li>
<li>In order to find an IOC repository, it needs to exist in the <Link href="https://gitlab.esss.lu.se/iocs" target="_blank" rel="noreferrer">iocs GitLab group</Link>.</li> <li>In order to find an IOC repository, it needs to exist in the &quot;<Link href="https://gitlab.esss.lu.se/iocs" target="_blank" rel="noreferrer">iocs&#47;</Link>&quot; GitLab group.</li>
</ul> </ul>
<h4>What does the deployment system do? Is there something I need to be aware of?</h4> <h4>What does the deployment system do? Is there something I need to be aware of?</h4>
......
src/views/home/HomeView.js
+ 3
− 3
View file @ dc36c95a
...@@ -53,7 +53,7 @@ export function HomeView() { ...@@ -53,7 +53,7 @@ export function HomeView() {
<Grid item xs={10}> <Grid item xs={10}>
<Box display="flex" flexDirection="row" p={2} m={1}> <Box display="flex" flexDirection="row" p={2} m={1}>
<Typography variant="h2"> <Typography variant="h2">
My statistics Account overview
</Typography> </Typography>
</Box> </Box>
</Grid> </Grid>
...@@ -66,8 +66,8 @@ export function HomeView() { ...@@ -66,8 +66,8 @@ export function HomeView() {
<Grid item xs={12}> <Grid item xs={12}>
<KeyValueTable <KeyValueTable
obj={{ obj={{
"Total number of my IOCs": statistics.numberOfActiveIocs, "IOCs registered": statistics.numberOfActiveIocs,
"Number of my IOCs with issues": iocsWithAlarms.length "IOCs with issues": iocsWithAlarms.length
}} }}
variant="table" /> variant="table" />
</Grid> </Grid>
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment