You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The purpose of Sequences As Code (SaC) is to provide teams with a quick and efficient means of creating guided learning paths in the form of sequences as code.
3
+
All notable changes to the Sequences As Code (SaC) project will be documented in this file.
4
4
5
-
For more information, please visit the [Sequences-as-Code](https://github.com/dxc-technology/Sequences-as-Code) repository.
5
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Copy file name to clipboardExpand all lines: README.md
+15-88Lines changed: 15 additions & 88 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The purpose of the Sequences As Code (SaC) application is to:
10
10
11
11
- Enable sequences to be created and managed in the form of code in GitHub.
12
12
13
-
- Give SME's a means of creating interactive, embedded hyperlinks, sequences and thus to take a task / process based approach to training people
13
+
- Give people a means of creating interactive (embedded hyperlinks) sequences and thus to take a task / process based approach to training people
14
14
15
15
- Facilitate the development of training which is, as per the recommendations of the Learning Pyramid, more participatory in nature.
16
16
@@ -30,102 +30,29 @@ Potential use cases include:
30
30
31
31
These use cases support the concept of the [learning pyramid](https://www.educationcorner.com/the-learning-pyramid.html) developed by the [National Training Laboratories Institute](https://www.ntl.org/). The learning pyramid suggests that some forms of learning lead to better learning experiences and thus better retention outcomes than others.
32
32
33
-
## Creating Sequences
33
+
## Changelog
34
34
35
-
Using SaC sequences are created as UML and grouped together as Missions.
35
+
See a [history of the changes](CHANGELOG.md) to **SaC (Sequences as Code)**.
36
36
37
-
Details on how to create the missions and sequences can be found in the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission and associated sequences.
37
+
## Documentation
38
38
39
-
### Creating Sequences - Automatically
39
+
For instructions on how to perform common SaC tasks please see the [documentation](./docs/README.md).
40
40
41
-
The option to convert the UML files to SVG is offered on every code commit from the continuous integration GitHub Action.
42
-
43
-
### Creating Sequences - Manually
44
-
45
-
Additionally the UML files can be converted to SVG manually in a local copy of a [Sequences as Code](https://github.com/dxc-technology/Sequences-as-Code) repository.
46
-
47
-
To generate the SVG files for a repository created from a release on the [Sequences as Code](https://github.com/dxc-technology/Sequences-as-Code), clone the repository then open a terminal session and run
48
-
49
-
```bash
50
-
./generatesvg.sh
51
-
```
52
-
53
-
The `./generatesvg.sh` script uses PlantUML a dockerized command line utility to convert UML files to SVG files. The script requires docker to be installed and running locally.
54
-
55
-
**Tip 1**`./generatesvg.sh` will generate SVG files for all the UML files it finds in the mission subfolders of the folder `src/sequences`. This may take some and should not be necessary for the [sachelp](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission. Prior to running `./generatesvg.sh` you can adjust the script to ensure it only finds and processes the UML files you need processed.
56
-
57
-
**Tip 2** When running the `./generatesvg.sh` script you can ignore any WARNINGS reported. In the event of an ERROR unfortunately no details are provided by `think/plantuml`, so to view the specific error details you can use [PlantText](https://www.planttext.com/).
58
-
59
-
## Linking Sequences to Sequences
60
-
61
-
The create-react-app tool chain was used to create the single paged SaC application. The create-react-app scaffolder ensures each file inside of the build/static directory will have a unique hash appended to the filename. The unique hash is generated based on the contents of the file, this is to avoid browsers needing to re-download your assets if the file contents haven't changed. If the contents of a file changes in a subsequent build, the filename hash that is generated will be different.
62
-
63
-
For images the filenames when built and deployed, both automatically and manually, are changed from
64
-
65
-
``
66
-
image.svg
67
-
``
41
+
## Contributing
68
42
69
-
to
43
+
We welcome all contributions please refer to [CONTRIBUTING.MD](/CONTRIBUTING.md) for details on how to contribute to this repository.
70
44
71
-
``
72
-
image.hash.svg
73
-
``
45
+
## Issues
74
46
75
-
The fact that the sequence file names can change if the SVG files are regenerated prevents sequences from linking to other sequences.
47
+
If you experience some problems with the existing scenarios, please open an
To allow sequences to link to other sequences a set of SaC "hashed" images are available in the `https://github.com/your_organisation/your_repository/images` folder. These images have consistent names as the SaC hash gives the image files the following names
51
+
## License
78
52
79
-
``
80
-
sequence.image.svg
81
-
``
53
+
This project is licensed under the Mozilla Public License Version 2.0 - see
54
+
the [LICENSE](LICENSE) file for details.
82
55
83
-
## React Bootstrapped Readme.md
56
+
## Create React App - Bootstrapped Readme.md
84
57
85
58
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). For your convenience the bootstrapped README.md is available at[CRA-README.md](./CRA-README.md).
86
-
87
-
## Working Locally
88
-
89
-
When creating sequences you may want to run the application locally to test them.
90
-
91
-
To do this:
92
-
93
-
- Open a terminal session and go to your cloned copy of the SaC repository
94
-
95
-
- Lint to verify react code is syntactically correct - `npm run lint`
96
-
97
-
- Run unit tests - `npm test`
98
-
99
-
- Verify test coverage - `npm run coverage`
100
-
101
-
- Run locally - `npm start` the application should be available at [http://localhost:3000](http://localhost:3000)
102
-
103
-
## Deploying
104
-
105
-
### From your local machine
106
-
107
-
When linting and testing is successful you can deploy the solution from your local environment using following command
108
-
109
-
-`npm run deploy`
110
-
111
-
as the solution has been configured to be hosted in a [GitHub pages site](https://github.com/gitname/react-gh-pages) after deployment it will be available at [http://github.com/pages/your_repository].
112
-
113
-
## Releases
114
-
115
-
SaC releases are available in GitHub under [Releases](https://github.com/dxc-technology/Sequences-as-Code/releases).
116
-
117
-
The contents and changes in each release are documented in the [CHANGELOG.md](https://github.com/dxc-technology/Sequences-as-Code/blob/master/CONTRIBUTING.md).
118
-
119
-
Note: Releases are created from the Jenkinsfile. When a pull request is being merged to Master the option to create a release is offered via an input dialog.
120
-
121
-
### Stand up a new Instance of SaC
122
-
123
-
To stand up a new instance of SaC follow the instructions in the *Create new dedicated instance of SaC* sequence in the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission.
124
-
125
-
### Update an Instance of SaC
126
-
127
-
To update an instance of SaC follow the instructions in the *Update an instance of SaC with a new release* sequence in the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission.
128
-
129
-
## Contributing
130
-
131
-
We welcome all contributions please refer to [CONTRIBUTING.MD](/CONTRIBUTING.md) for details on how to contribute to this repository.
The following instructions describe how to perform common tasks related to Sequences as Code.
4
+
5
+
## Creating Sequences
6
+
7
+
Using SaC sequences are created as UML and grouped together as Missions.
8
+
9
+
Details on how to create the missions and sequences can be found in the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission and associated sequences.
10
+
11
+
### Creating Sequences - Automatically
12
+
13
+
The option to convert the UML files to SVG is offered on every code commit from the continuous integration GitHub Action.
14
+
15
+
### Creating Sequences - Manually
16
+
17
+
Additionally the UML files can be converted to SVG manually in a local copy of a [Sequences as Code](https://github.com/dxc-technology/Sequences-as-Code) repository.
18
+
19
+
To generate the SVG files for a repository created from a release on the [Sequences as Code](https://github.com/dxc-technology/Sequences-as-Code), clone the repository then open a terminal session and run
20
+
21
+
```bash
22
+
./generatesvg.sh
23
+
```
24
+
25
+
The `./generatesvg.sh` script uses PlantUML a dockerized command line utility to convert UML files to SVG files. The script requires docker to be installed and running locally.
26
+
27
+
**Tip 1**`./generatesvg.sh` will generate SVG files for all the UML files it finds in the mission subfolders of the folder `src/sequences`. This may take some and should not be necessary for the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission. Prior to running `./generatesvg.sh` you can adjust the script to ensure it only finds and processes the UML files you need processed.
28
+
29
+
**Tip 2** When running the `./generatesvg.sh` script you can ignore any WARNINGS reported. In the event of an ERROR unfortunately no details are provided by `think/plantuml`, so to view the specific error details you can use [PlantText](https://www.planttext.com/).
30
+
31
+
## Linking Sequences to Sequences
32
+
33
+
The create-react-app tool chain was used to create the single paged SaC application. The create-react-app scaffolder ensures each file inside of the build/static directory will have a unique hash appended to the filename. The unique hash is generated based on the contents of the file, this is to avoid browsers needing to re-download your assets if the file contents haven't changed. If the contents of a file changes in a subsequent build, the filename hash that is generated will be different.
34
+
35
+
For images the filenames when built and deployed, both automatically and manually, are changed from
36
+
37
+
``
38
+
image.svg
39
+
``
40
+
41
+
to
42
+
43
+
``
44
+
image.hash.svg
45
+
``
46
+
47
+
The fact that the sequence file names can change if the SVG files are regenerated prevents sequences from linking to other sequences.
48
+
49
+
To allow sequences to link to other sequences a set of SaC "hashed" images are available in the `https://github.com/your_organisation/your_repository/images` folder. These images have consistent names as the SaC hash gives the image files the following names
50
+
51
+
``
52
+
sequence.image.svg
53
+
``
54
+
55
+
## Working Locally
56
+
57
+
When creating sequences you may want to run the application locally to test them.
58
+
59
+
To do this:
60
+
61
+
- Open a terminal session and go to your cloned copy of the SaC repository
62
+
63
+
- Lint to verify react code is syntactically correct - `npm run lint`
64
+
65
+
- Run unit tests - `npm test`
66
+
67
+
- Verify test coverage - `npm run coverage`
68
+
69
+
- Run locally - `npm start` the application should be available at [http://localhost:3000](http://localhost:3000)
70
+
71
+
## Deploying
72
+
73
+
### From your local machine
74
+
75
+
When linting and testing is successful you can deploy the solution from your local environment using following command
76
+
77
+
-`npm run deploy`
78
+
79
+
as the solution has been configured to be hosted in a [GitHub pages site](https://github.com/gitname/react-gh-pages) after deployment it will be available at [http://github.com/pages/your_repository].
80
+
81
+
## Releases
82
+
83
+
SaC releases are available in GitHub under [Releases](https://github.com/dxc-technology/Sequences-as-Code/releases).
84
+
85
+
The contents and changes in each release are documented in the [CHANGELOG.md](https://github.com/dxc-technology/Sequences-as-Code/blob/master/CHANGELOG.md).
86
+
87
+
## Stand up a new Instance of SaC
88
+
89
+
To stand up a new instance of SaC follow the instructions in the *Create new dedicated instance of SaC* sequence in the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission.
90
+
91
+
## Update an Instance of SaC
92
+
93
+
To update an instance of SaC follow the instructions in the *Update an instance of SaC with a new release* sequence in the SaC [Help](https://github.com/pages/dxc-technology/Sequences-as-Code/#/sachelp) mission.
0 commit comments