Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
kordwarshuis committed Jan 16, 2025
2 parents 1740a10 + ad317a3 commit 2bf6506
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
19 changes: 16 additions & 3 deletions docs/general/add-content/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ This creates `terms-and-definitions-intro.md` in the `/spec` directory DON'T TOU
### Feel free to reorganize the order of term in the glossary
Open the `terms-index.json` with a text editor in the root of the repo and change the order of terms. You can even throw terms out.

::: note Plan to change
:::note Plan to change
`terms-index.json` will be a file that can't be editted by the user. We'll create the following process:
- a user bypasses a term file (that is in draft) using an `_` (underscore) as the first character of the file name
- a user create a custom order (default: alphabetically) by putting an order number as the first 3 characters of a filename. Example: `10_validator.md`, `15_autonomous-identifier.md`, etc.
Expand Down Expand Up @@ -154,6 +154,20 @@ Install Spec-Up-T and install all dependencies:
```
npm install
```
:::note Ignore warnings
During the process, you can ignore the NPM warnings.

Keeping up-to-date with warnings would demand a daily effort from programmers and maintainers. Things change so quickly but are hardly ever a breaking change.
:::

<<<<<<< HEAD
:::tip Optional extra check
=======
:::todo Optional extra check
>>>>>>> upstream/main
Do the extra check with the "NPM list" command to see whether your install or update command has worked as expected. Check the packages and their latest version numbers.
:::

Go into the menu

```
Expand Down Expand Up @@ -186,5 +200,4 @@ What you also should have is:
Follow the steps to take here if you want to use a different account or repo: [Add repo to Github](https://trustoverip.github.io/spec-up-t-website/docs/various-roles/admins-guide/updating/#copy-files-to-the-root-of-your-installation)

## Organize your Terminology data
- Split your Terms and Definition into separate files under a directory in `/spec` directory

- Split your Terms and Definition into separate files under a directory in `/spec` directory
11 changes: 7 additions & 4 deletions docs/general/add-content/populate.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ npx create-spec-up-t ./Main-KERI-glossary
Go to `Main-KERI-glossary-OLD`
Open Specs.json and copy the list of `markdown_paths` and paste the list into the specs.json of `Main-KERI-glossary` under `markdown_paths` and remove the terminology markdown file (e.g., `terms-definitions.md`) from the list.

::: warning
:::warning
Don't delete the terms-definitions.md, we need the content later!
:::

Expand Down Expand Up @@ -73,7 +73,7 @@ ls
rm terms-and-definitions.md
```

::: note
:::note
with the above command, we suggest the old and new repos are both in the same parent directory.

We do not need the copy of terms-and-definitions.md
Expand All @@ -88,9 +88,12 @@ Two approaches:
2. use the splitter tool

#### 1. By hand splitting of term-defnitions file
Example: `terms-and-definitions.md` contains 5 defnitions -> 5 files with the name of the term as the file name in a new directory named `terms-definitions` in the `./spec` directory of the Spec-Up-T install:
Example: `terms-and-definitions.md` contains 5 definitions -> 5 separate files, optionally with the name of the term as the file name, in a new directory named `terms-definitions` in the `./spec` directory of the Spec-Up-T install.

::: warning
##### Alpha-numerical sorting
If you choose to have leading numbers in the filename (e.g., `13verifier.md`, `1200ssi.md`), the files will be used in this order. Any file without a number will be appended in the output alphabetically, AFTER the numbered files.

:::warning
The name of the directory is declared in `specs.json` under "spec_terms_directory" entry.
:::

Expand Down

0 comments on commit 2bf6506

Please sign in to comment.