Skip to content

Commit

Permalink
made changes to account for renamed ssg repo refs #91; updated citati…
Browse files Browse the repository at this point in the history
…on information
  • Loading branch information
jspaaks committed Aug 28, 2023
1 parent 03ed8e7 commit f37280d
Show file tree
Hide file tree
Showing 8 changed files with 10,905 additions and 10,901 deletions.
10 changes: 5 additions & 5 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ authors:
orcid: 'https://orcid.org/0000-0001-9448-4023'
identifiers:
- type: url
value: 'https://github.com/ardc-fair-checklist/ssg'
value: 'https://github.com/ardc-fair-checklist/ardc-fair-checklist'
description: Where the software is being developed
- type: url
value: 'https://ardc-fair-checklist.github.io/ssg/'
value: 'https://ardc-fair-checklist.github.io/'
description: Where the software is deployed
repository-code: 'https://github.com/ardc-fair-checklist/ssg'
url: 'https://ardc-fair-checklist.github.io/ssg/'
repository-code: 'https://github.com/ardc-fair-checklist/ardc-fair-checklist'
url: 'https://ardc-fair-checklist.github.io/'
abstract: >-
The software for a self-assessment web form that allows authors to evaluate the FAIRness of their
research software, resulting in a badge that they can put in their project's README.
Expand All @@ -38,7 +38,7 @@ keywords:
- RSE
- Research Software Engineer
license: Apache-2.0
version: 0.2.0-rc0
version: 0.2.0
references:
-
authors:
Expand Down
6 changes: 4 additions & 2 deletions README.dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ We recommend using Volar VSCode extension for improved development experience. T

```shell
cd <some dir>
git clone https://github.com/ardc-fair-checklist/ssg .
git clone https://github.com/ardc-fair-checklist/ardc-fair-checklist .
npm install
```

Expand All @@ -35,6 +35,7 @@ npm install
- `npm run server:prod`: serve the production build
- `npm run test`: run the unit tests in watch mode using `vitest`

<!--
## Known problem with `npm run prod`
Running `npm run prod` results in a production site that can't resolve some of its own assets when run locally and combined with not undefined `base` option in `vite.config.js`. A possible workaround is to build the production files, then insert a directory with the same name as `base` between `server`|`client` and their files, like so:
Expand All @@ -50,6 +51,7 @@ mv $LIST_CLIENT dist/client/$BASE/
mv $LIST_SERVER dist/server/$BASE/
npm run server:prod
```
-->

relevant version info from `npm list`:

Expand Down Expand Up @@ -81,7 +83,7 @@ In the current app, there are multiple entities that could be versioned, namely

### GitHub Pages

There is a GitHub action `/.github/workflows/publish.yml` that builds the project for production and hosts it at https://ardc-fair-checklist.github.io/ssg. The GitHub action can be triggered manually via the GitHub user interface.
There is a GitHub action `/.github/workflows/publish.yml` that builds the project for production and hosts it at https://ardc-fair-checklist.github.io/. The GitHub action can be triggered manually via the GitHub user interface.

### Zenodo

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ An interactive checklist with questions about FAIRness of research software. The

The checklist yields hyperlinked badges like this one:

[![FAIRness badge image](https://ardc-fair-checklist.github.io/ssg/badge.svg)](https://ardc-fair-checklist.github.io/ssg/v0.1?f=111111&a=1111&i=11&r=111111)
[![FAIRness badge image](https://ardc-fair-checklist.github.io/badge.svg)](https://ardc-fair-checklist.github.io/v0.1?f=111111&a=1111&i=11&r=111111)

Here's what the corresponding Markdown looks like for that badge:

```markdown
[![FAIRness badge image](https://ardc-fair-checklist.github.io/ssg/badge.svg)](https://ardc-fair-checklist.github.io/ssg/v0.1?f=111111&a=1111&i=11&r=111111)
[![FAIRness badge image](https://ardc-fair-checklist.github.io/badge.svg)](https://ardc-fair-checklist.github.io/v0.1?f=111111&a=1111&i=11&r=111111)
```

The app state should be restored to have the second answer for each question selected.
Loading

0 comments on commit f37280d

Please sign in to comment.