Skip to content

Commit 5f2586d

Browse files
ppanerofenekku
authored andcommitted
global: typo and phrasing fixes
Co-Authored-By: fenekku <[email protected]>
1 parent 13cc4e6 commit 5f2586d

File tree

6 files changed

+20
-19
lines changed

6 files changed

+20
-19
lines changed

docs/develop/customize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ Passing the `--no-install-js` option, skips re-installation of JS dependencies.
2222
Go to the browser [*https://localhost:5000/*](https://localhost:5000) or refresh the page. And voilà! The logo has been changed!
2323

2424
!!! warning "That evil cache"
25-
If you do not see it changing, check in an incognito window, the browser might have cached the logo.
25+
If you do not see it changing, check in an incognito window; the browser might have cached the logo.
2626

2727
Need further customizations? Have you thought of creating your own extensions? How to add them to your InvenioRDM instance is explained in the next section - [here](../extensions/custom.md).

docs/extensions/custom.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Extensions
22

3-
If you need to add custom functionalaty to your RDM instance you need to develop your own module. You can start it by using the [cookiecutter-invenio-module](https://github.com/inveniosoftware/cookiecutter-invenio-module) template. It will get you started in no time.
3+
If you want to add custom functionality to your RDM instance, you need to develop your own module. You can start in no time by using the [cookiecutter-invenio-module](https://github.com/inveniosoftware/cookiecutter-invenio-module) template.
44

55
## Create your module
6-
Lets assume you have already done so:
6+
Let's run the cookiecutter:
77

88
``` console
99
$ cookiecutter https://github.com/inveniosoftware/cookiecutter-invenio-module
@@ -13,10 +13,11 @@ $ cookiecutter https://github.com/inveniosoftware/cookiecutter-invenio-module
1313

1414
## Add your functionality
1515

16-
And you have added a simple view to the blue print in the `<your_custom_module>/views.py`, which looks like:
16+
We've added a simple view to the blueprint in `<your_custom_module>/views.py`, which looks like:
1717

1818
``` python
19-
[...]
19+
# Other code ignored for clarity
20+
2021
blueprint = Blueprint(
2122
'invenio_rdm_extension_demo',
2223
__name__
@@ -38,7 +39,7 @@ $ cd path/to/your/instance
3839
$ pipenv install [--pre] -e path/to/your/extension
3940
```
4041

41-
As you can see, `--pre` is optional, it is only needed when the package is in a pre-release state. In addition, note that you do not need to specify a local path, if the package is available e.g. via PyPi you can just install it by its name.
42+
As you can see, `--pre` is optional. It is only needed when the package is in a pre-release state. In addition, note that you do not need to specify a local path. If the package is available e.g. via PyPi, you can just install it by its name.
4243

4344
## Sanity check and run!
4445

docs/extensions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ InvenioRDM supports a great variety of extensions that can help you adapt it to
66

77
### Storage
88

9-
- [S3](s3.md)
9+
- [S3](s3.md) can be configured to serve as your storage backend via the [invenio-s3](https://github.com/inveniosoftware/invenio-s3) extension. If you chose S3 as storage when initializing your instance, [navigate here](#i-chose-s3-when-initializing-the-repository). Otherwise, [navigate to this section](#i-didnt-choose-s3-when-initializing).

docs/extensions/s3.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## I chose S3 when initializing the repository!
44

5-
If you are reading the section you are lucky! you will only have to perform a few configuration changes. If on the contrary you didn't choose S3 as storage when initializing the repository file system, [navigate below](#i-didnt-choose-s3-when-initializing) to follow more in depth changes!
5+
If you are reading this section, you are lucky! You will only have to perform a few configuration changes. If on the contrary you didn't choose S3 as storage when initializing the repository file system, [navigate below](#i-didnt-choose-s3-when-initializing) to follow more in depth instructions!
66

77
### Create a bucket
88

9-
InvenioRDM uses a [minio](https://min.io/download) container for S3 alike storage. To create a bucket in minio you can:
9+
InvenioRDM uses a [MinIO](https://min.io/download) container for S3-like storage. To create a bucket in MinIO you can:
1010

11-
a. Install the [mc tool](https://docs.min.io/docs/minio-client-quickstart-guide.html) and run the following command, where `defaul-bucket` is the name of your bucket.
11+
a. Install the [mc tool](https://docs.min.io/docs/minio-client-quickstart-guide.html) and run the following command, where `default-bucket` is the name of your bucket.
1212

1313
``` console
1414
$ mc mb default-bucket
@@ -18,7 +18,7 @@ b. Use the web UI (https://localhost[:9000]/minio). In the bottom right you will
1818

1919
### Create a new location
2020

21-
Now you need to tell InvenioRDM where is that bucket, for that create a new location. If you are running a local (development) instance, run:
21+
Now you need to tell InvenioRDM where that bucket is. For that, create a new location. If you are running a local (development) instance, run:
2222

2323
``` console
2424
$ cd path/to/your/instance
@@ -28,20 +28,20 @@ $ pipenv run invenio files location s3-default s3://default-bucket --default
2828
If you are running the containerized version, run:
2929

3030
``` console
31-
$ docker exec -it < web_[api|ui] container name or id> /bin/bash
32-
$ invenio files location s3-default s3://default-bucket --default
31+
$ docker exec -it <web_[api|ui] container name or id> /bin/bash
32+
$ invenio files location create s3-default s3://default-bucket --default
3333
```
3434

3535
### Set your credentials
3636

3737
The last step is to set your credentials so your instance can authenticate against the S3 container.
3838

39-
By default the `ACCESS_KEY` and the `ACCESS_ID` of minio are "CHANGE_ME", and so they are set in the `invenio.cfg` file. If you changed them (you should) modify them accordingly in the config file.
39+
By default, the `ACCESS_KEY` and the `ACCESS_ID` of MinIO are "CHANGE_ME", and so they are set in the `invenio.cfg` file. If you changed them (you should) modify them accordingly in the config file.
4040

4141
It's done! Ready to roll!
4242

4343
## I didn't choose S3 when initializing
4444

4545
You are here, but do not panic, is not difficult just longer.
4646

47-
This docs will come soon, for now we apologize for the hussle, but could you create a new instance to test S3?
47+
Coming soon.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ the workflow to be effective with them.
3939

4040
## Extensions
4141

42-
InvenioRDM supports a great variety of extensions that can help you adapt it to your infrastructure, it also supports the addition of custom made ones.
42+
InvenioRDM supports a great variety of extensions that can adapt it to your infrastructure. It also supports the addition of custom made ones.
4343

4444
[> Extensions setup](extensions/index.md)
4545

docs/install/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Some system requirements are needed beforehand:
1313
- [Docker-Compose](https://docs.docker.com/compose/) (1.17.0+)
1414

1515
!!! warning "Other Python distributions"
16-
InvenioRDM works with Python 3.6.2. However, many users have reported errors when running Python from Anaconda.
16+
InvenioRDM targets CPython 3.6 (lowest 3.6.2). Anaconda Python in particular is not currently supported and other Python distributions are not tested.
1717

1818
In addition, make sure the user that will be executing the CLI has access to
1919
the docker command (i.e. it is not only available for the root user):
@@ -23,7 +23,7 @@ $ sudo usermod --append --groups docker $USER
2323
```
2424

2525
!!! note "Hardware requirements"
26-
We usually deploy the RDM in machines that have around 8GB of RAM and at least 4 cores. InvenioRDM can certainly run (for demo purposes) with less, just take into account that you are going to be runing between 4 and 8 containers (among them ES, which is quite demanging).
26+
We usually deploy the RDM in machines that have around 8GB of RAM and at least 4 cores. InvenioRDM can certainly run (for demo purposes) with less, just take into account that you are going to be running between 4 and 8 containers (among them an Elasticsearch container, which is quite demanding).
2727

2828
Once you have installed these requirements, you can install the CLI.
2929

@@ -59,4 +59,4 @@ invenio-cli, version 0.10.0
5959
```
6060

6161
!!! note "CLI version"
62-
The CLI is in pre 1.0 release. The last release's version is **0.10.0**. Your version may be different than the above.*
62+
The CLI is in pre 1.0 release. The last release's version is **0.10.0**. Your version may be different than the above.

0 commit comments

Comments
 (0)