Skip to content

Commit

Permalink
Replace spec-up-t-starterpack with spec-up-t-boilerplate
Browse files Browse the repository at this point in the history
  • Loading branch information
kordwarshuis committed Jan 17, 2025
1 parent 5a346c4 commit ebc7091
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions docs/general/add-content/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ cp specs.json specs-backup.json
cp package.json package-backup.json
```

Be sure to get the latest specs.json [here](https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-starterpack/specs.json) from the starter pack and save into the root of the repo.
Be sure to get the latest specs.json [here](https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/specs.json) from the starter pack and save into the root of the repo.

## Modify your Spec-Up installation with Spec-Up-T install

Expand Down Expand Up @@ -97,7 +97,7 @@ This method is adopted from Docusaurus.
"intro.md",
**| copy your .md files here, listed in specs.json-backup, excluding the terminology md files |**
],
"logo": "https://raw.githubusercontent.com/blockchainbird/spec-up-t-starter-pack/main/spec-up-t-starterpack/logo.svg",
"logo": "https://raw.githubusercontent.com/blockchainbird/spec-up-t-starter-pack/main/spec-up-t-boilerplate/logo.svg",
"logo_link": "https://github.com/blockchainbird/spec-up-t",
"source": {
"host": "github",
Expand Down Expand Up @@ -131,7 +131,7 @@ This method is adopted from Docusaurus.
}
```

**Be sure to get the latest specs.json [here](https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-starterpack/specs.json)**
**Be sure to get the latest specs.json [here](https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/specs.json)**

Copy your old order of files from `specs-backup.json` and add `terms-and-definitions-intro.md` somewhere in the list (you choose the order!)

Expand Down
4 changes: 2 additions & 2 deletions docs/general/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ The `specs.json` file, located in the root folder of your repository, specifies
"example-markup-in-markdown.md",
"spec-body.md"
],
"logo": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-starterpack/static/logo.svg",
"logo": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-boilerplate/static/logo.svg",
"logo_link": "https://github.com/trustoverip/spec-up-t",
"favicon": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-starterpack/static/favicon.ico",
"favicon": "https://raw.githubusercontent.com/trustoverip/spec-up-t-starter-pack/main/spec-up-t-boilerplate/static/favicon.ico",
"source": {
"host": "github",
"account": "trustoverip",
Expand Down
4 changes: 2 additions & 2 deletions docs/general/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ You can also omit the last part:
npx create-spec-up-t
```

If you omit `my-spec-up-t-website`, a default directory name, namely `spec-up-t-starterpack,` is used.
If you omit `my-spec-up-t-website`, a default directory name, namely `spec-up-t-boilerplate,` is used.

Sometimes, you want to force the latest version to be installed. Then you can do the following:

Expand All @@ -56,7 +56,7 @@ You can type this command into Command Prompt, Powershell, Terminal, or any othe

### Result

You should now have a directory called `my-spec-up-t-website` (or `spec-up-t-starterpack` if you did not specify a name) with a subdirectory called `spec/`. You will find markdown files and another subdirectory, `terms-definitions` containing markdown files containing some sample content.
You should now have a directory called `my-spec-up-t-website` (or `spec-up-t-boilerplate` if you did not specify a name) with a subdirectory called `spec/`. You will find markdown files and another subdirectory, `terms-definitions` containing markdown files containing some sample content.

What you don't have yet is the following:

Expand Down
2 changes: 1 addition & 1 deletion docs/q-and-a.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Our enhancement proposal and git governance strategy is [here](how-it-came-to-be

## Why doesn't the Spec-Up-T repo generate a github.io-served specification itself?

The repo Spec-Up-T doesn't generate an example specification on github.io. because it's not the purpose of this repo. Your example site will pop up when “spec-up-t” is installed in node_modules of spec-up-t-starterpack when you run npm install.
The repo Spec-Up-T doesn't generate an example specification on github.io. because it's not the purpose of this repo. Your example site will pop up when “spec-up-t” is installed in node_modules of spec-up-t-boilerplate when you run npm install.

## How to integrate Spec-Up-T in other systems

Expand Down
4 changes: 2 additions & 2 deletions docs/various-roles/admins-guide/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Here is a step-by-step description:

### Source files in the Installer

The information (files, code) to be copied to your existing Spec-Up-T installation can be found in the [directory `spec-up-t-starterpack` of the installer](https://github.com/blockchainbird/spec-up-t-starter-pack/tree/main/spec-up-t-starterpack).
The information (files, code) to be copied to your existing Spec-Up-T installation can be found in the [directory `spec-up-t-boilerplate` of the installer](https://github.com/blockchainbird/spec-up-t-starter-pack/tree/main/spec-up-t-boilerplate).


### `package.json`
Expand All @@ -43,7 +43,7 @@ Copy the following information from the `package.json` file in the aforementione
"version": "-.-.-"
```

The “-”'s are placeholders, use the version number as listed in [this file](https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-starterpack/package.json#L3)
The “-”'s are placeholders, use the version number as listed in [this file](https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/package.json#L3)

### Copy files to the root of your installation

Expand Down
12 changes: 6 additions & 6 deletions docs/various-roles/developers-guide/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,23 @@ The Spec-Up-T Installer repository installs a set of files somewhere on a file s

The Spec-Up-T Installer repository has a subdirectory named `spec-up-t-starter-pack`. This subdirectory is a working Spec-Up-T install. The scripts in the root copy this subdirectory to your chosen location on your file system via an NPX command (or you do this via GitHub's web interface, but this is under development, as mentioned above).

Note: You can also copy `spec-up-t-starterpack/` manually and then call `npm install`. That has the same result.
Note: You can also copy `spec-up-t-boilerplate/` manually and then call `npm install`. That has the same result.

When you run this NPX command, this subdirectory is copied to your local file system, and then, when that is done, `npm install` is called. This installs the packages as defined in the co-copied `package.json`, which is also in the mentioned subdirectory. The `package.json` in the root of the repository serves to copy the subdirectory to your local file system, via `create-spec-up-t-starterpack.js`.

:::info
The relevant files + a directory in the Spec-Up-T installer repository:

```
spec-up-t-starterpack/
spec-up-t-boilerplate/
create-spec-up-t-starterpack.js
messages.js
package.json
```

This directory contains a working Spec-Up-T:
```
spec-up-t-starterpack/
spec-up-t-boilerplate/
```

These files …
Expand All @@ -59,7 +59,7 @@ messages.js
package.json
```

… copy the `spec-up-t-starterpack/` directory to your desired location via NPX.
… copy the `spec-up-t-boilerplate/` directory to your desired location via NPX.
:::

### The Spec-Up-T repository
Expand Down Expand Up @@ -270,8 +270,8 @@ It's easy to forget to update the version nummer in different locations. Please

Update the version number in four `package.json`'s. The idea is to keep the version numbers of all repos the same. If you publish an update to NPM you have to raise the version number in four places:

1. https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-starterpack/package.json#L3
2. https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-starterpack/package.json#L8
1. https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/package.json#L3
2. https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/spec-up-t-boilerplate/package.json#L8
3. https://github.com/trustoverip/spec-up-t-starter-pack/blob/main/package.json#L3
4. https://github.com/trustoverip/spec-up-t/blob/master/package.json#L3

Expand Down

0 comments on commit ebc7091

Please sign in to comment.