-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
migration from Spec-Up to Spec-Up-T added
Signed-off-by: henkvancann <[email protected]>
- Loading branch information
1 parent
18b5907
commit 2be285b
Showing
1 changed file
with
136 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Migration | ||
|
||
**Pre condition: You have a Spec-Up installation up and running** | ||
|
||
|
||
## What you'll need | ||
|
||
- A terminal / Command Line | ||
- An editor, also called IDE (Integrated Development Environment). We recommend Visual Studio Code, but an editor in which you can quickly write Markdown is also good | ||
- [Node.js](https://nodejs.org/en/download/): | ||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies | ||
- Use Node.js version 18 or higher | ||
- A [webbrowser](https://en.wikipedia.org/wiki/Web_browser). You are probably reading this in a browser, so you already have one | ||
- [Git](https://git-scm.com/). To host your specification on Github, you must also have Git installed on your local system. By the way, you can also create a specification (index.html) without hosting it on GitHub. But if you do so, the whole idea of a version-managed glossary using Git goes through the window. | ||
|
||
:::info | ||
Non-technical explanation: | ||
- Command Line: A text interface to type commands for your computer. | ||
- IDE: A software where you can easily write, test, and debug code. | ||
- Node.js: This makes Spec-Up and Spec-Up-T run | ||
- Git: A system to track and manage changes in your code. | ||
::: | ||
|
||
## Organize your Terminology data | ||
|
||
- Split your Terms and Definition into seperate files under a directory in `/spec` directory | ||
- Adjust your Spec.json accordingly | ||
- Add a Terms-spec.json | ||
- | ||
|
||
## Modify your Spec-Up installation with Spec-Up-T install | ||
|
||
### General info | ||
|
||
Installing Spec-Up-T is as follows: | ||
|
||
- Install the tool via `npx` | ||
- Install the spec-up-t package via `npm` | ||
|
||
It is explained in more detail below: | ||
|
||
### Let's create | ||
|
||
```bash | ||
npx create-spec-up-t my-spec-up-t-website | ||
``` | ||
|
||
*my-spec-up-t-website* can be anything you want it to be (however, it is recommended to not use spaces or special characters in directory names). | ||
|
||
You can also omit the last part: | ||
|
||
```bash | ||
npx create-spec-up-t | ||
``` | ||
|
||
If you omit `my-spec-up-t-website`, a default directory name, namely `spec-up-t-starterpack,` is used. | ||
|
||
Sometimes, you want to force the latest version to be installed. Then you can do the following: | ||
|
||
```bash | ||
npx create-spec-up-t@latest my-spec-up-t-website | ||
``` | ||
|
||
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. It should work on any operating system (not tested yet). | ||
|
||
You should now have a directory called `my-spec-up-t-website` (or `spec-up-t-starterpack` if you did not specify a name). | ||
|
||
### Go into the directory | ||
|
||
- Go into this directory (folder) that was just created: | ||
|
||
```bash | ||
cd my-spec-up-t-website | ||
``` | ||
|
||
You are now in this directory. | ||
|
||
### Install all dependencies | ||
|
||
- Install all dependencies: | ||
|
||
```bash | ||
npm run install | ||
``` | ||
|
||
It can take some time, and you should see multiple lines of output during installation. | ||
|
||
When the prompt is visible again, you should now have a basic Spec-Up-T install: | ||
|
||
- a `specs.json` file | ||
- a `spec/` directory with sample markdown files | ||
- a `node_modules` directory, a `package.json` file, and a `package-lock.json` file (these three elements belong to the `npm` system) | ||
|
||
What you don't have yet is the following: | ||
|
||
- a `docs` directory with a sample `index.html` file (which is the actual specification file that is the goal of it all). | ||
|
||
How to do this, go to the [General Instructions](./command-line-menu.md). | ||
|
||
### Add repo to Github | ||
|
||
You should push your new specification (i.e. the sample content) to a GitHub repo. | ||
|
||
These are the steps to take: | ||
|
||
#### Edit `specs.json` | ||
|
||
Change this entry in `specs.json`: | ||
|
||
```json | ||
"source": { | ||
"host": "github", | ||
"account": "blockchainbird", | ||
"repo": "spec-up-t-starter-pack" | ||
} | ||
``` | ||
|
||
to the correct information: | ||
|
||
```json | ||
"source": { | ||
"host": "github", | ||
"account": "your-account", | ||
"repo": "your-repo" | ||
} | ||
``` | ||
|
||
These are the host (GitHub), your GitHub account name, and the repo name of the repo you are about to push. | ||
|
||
#### Commit and Push repo to GitHub | ||
|
||
Now, commit your changes and push the repo to GitHub. Use the command line or your preferred way to do this. |