Skip to content

Commit 008cdd0

Browse files
committed
global: use generic project names
closes #24
1 parent 5237b14 commit 008cdd0

File tree

4 files changed

+32
-33
lines changed

4 files changed

+32
-33
lines changed

docs/develop/cleanup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Server and worker stopped...
1313
## Destroy the instance
1414

1515
If you want to get to a clean state with no images, containers or volumes, then destroy the instance. This **WILL** permanently erase your volume data (database and Elasticsearch indices).
16-
It destroys the images, containers and volumes defined in the `february-release-2/docker-compose.full.yml`.
16+
It destroys the images, containers and volumes defined in the `development-instance/docker-compose.full.yml`.
1717

1818
After stopping the application per above, destroy it:
1919

docs/develop/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ invenio-cli init --flavour=RDM
1919
```
2020
``` console
2121
Initializing RDM application...
22-
project_name [My Site]: February Release 2
23-
project_shortname [february-release-2]:
24-
project_site [february-release-2.com]:
25-
github_repo [february-release-2/february-release-2]:
26-
description [Invenio RDM February Release 2 Instance]:
22+
project_name [My Site]: Development Instance
23+
project_shortname [development-instance]:
24+
project_site [development-instance.com]:
25+
github_repo [development-instance/development-instance]:
26+
description [Invenio RDM Development Instance Instance]:
2727
author_name [CERN]:
28-
author_email [info@february-release-2.com]:
28+
author_email [info@development-instance.com]:
2929
year [2020]:
3030
Select database:
3131
1 - postgresql

docs/develop/install_locally.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ allowing you to iterate on your local instance quickly.
1010
Before going on, let's move into the project directory:
1111

1212
``` bash
13-
cd february-release-2
13+
cd development-instance
1414
```
1515

1616
To run the application locally, we will need to install it and its dependencies
@@ -50,12 +50,12 @@ invenio-cli services
5050
```
5151
``` console
5252
Making sure containers are up...
53-
Creating network "february-release-2_default" with the default driver
54-
Creating february-release-2_cache_1 ... done
55-
Creating february-release-2_es_1 ... done
56-
Creating february-release-2_db_1 ... done
57-
Creating february-release-2_mq_1 ... done
58-
Creating database postgresql+psycopg2://february-release-2:february-release-2@localhost/february-release-2
53+
Creating network "development-instance_default" with the default driver
54+
Creating development-instance_cache_1 ... done
55+
Creating development-instance_es_1 ... done
56+
Creating development-instance_db_1 ... done
57+
Creating development-instance_mq_1 ... done
58+
Creating database postgresql+psycopg2://development-instance:development-instance@localhost/development-instance
5959
Creating all tables!
6060
INFO [alembic.runtime.migration] Context impl PostgresqlImpl.
6161
INFO [alembic.runtime.migration] Will assume transactional DDL.
@@ -80,16 +80,16 @@ invenio-cli services --force
8080
```
8181
``` console
8282
Making sure containers are up...
83-
february-release-2_mq_1 is up-to-date
84-
february-release-2_db_1 is up-to-date
85-
february-release-2_cache_1 is up-to-date
86-
february-release-2_es_1 is up-to-date
83+
development-instance_mq_1 is up-to-date
84+
development-instance_db_1 is up-to-date
85+
development-instance_cache_1 is up-to-date
86+
development-instance_es_1 is up-to-date
8787
Cache cleared
88-
Destroying database postgresql+psycopg2://february-release-2:february-release-2@localhost/february-release-2
88+
Destroying database postgresql+psycopg2://development-instance:development-instance@localhost/development-instance
8989
Destroying indexes...
9090
Indexing queue has been initialized.
9191
Indexing queue has been purged.
92-
Creating database postgresql+psycopg2://february-release-2:february-release-2@localhost/february-release-2
92+
Creating database postgresql+psycopg2://development-instance:development-instance@localhost/development-instance
9393
Creating all tables!
9494
[####################################] 100%
9595
INFO [alembic.runtime.migration] Context impl PostgresqlImpl.
@@ -130,13 +130,12 @@ invenio-cli demo --local
130130
```
131131
``` console
132132
Making sure containers are up...
133-
february-release-2_mq_1 is up-to-date
134-
february-release-2_db_1 is up-to-date
135-
february-release-2_cache_1 is up-to-date
136-
february-release-2_es_1 is up-to-date
133+
development-instance_mq_1 is up-to-date
134+
development-instance_db_1 is up-to-date
135+
development-instance_cache_1 is up-to-date
136+
development-instance_es_1 is up-to-date
137137
Creating demo records...
138138
Created records!
139-
140139
```
141140

142141
We are ready to run it in the next section.

docs/preview/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,13 @@ invenio-cli init --flavour=RDM
3333
```
3434
``` console
3535
Initializing RDM application...
36-
project_name [My Site]: February Release
37-
project_shortname [february-release]:
38-
project_site [february-release.com]:
39-
github_repo [february-release/february-release]:
40-
description [Invenio RDM February Release Instance]:
36+
project_name [My Site]: InvenioRDM Preview
37+
project_shortname [inveniordm-preview]:
38+
project_site [inveniordm-preview.com]:
39+
github_repo [inveniordm-preview/inveniordm-preview]:
40+
description [Invenio RDM InvenioRDM Preview Instance]:
4141
author_name [CERN]:
42-
author_email [info@february-release.com]:
42+
author_email [info@inveniordm-preview.com]:
4343
year [2020]:
4444
Select database:
4545
1 - postgresql
@@ -71,7 +71,7 @@ Creating logs directory...
7171
Observe the generated files. A full description of each of them can be found in the [invenio-cli RFC](https://github.com/inveniosoftware/rfcs/pull/4)
7272

7373
``` bash
74-
ls -la february-release
74+
ls -la inveniordm-preview
7575
```
7676
``` console
7777
total 56
@@ -108,7 +108,7 @@ The project is initialized, we just need to run it. Switch to the project
108108
directory and do so:
109109

110110
``` bash
111-
cd february-release
111+
cd inveniordm-preview
112112
invenio-cli containerize
113113
```
114114
``` console

0 commit comments

Comments
 (0)