Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Grammar and other changes #33

Open
wants to merge 38 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
e43db55
Update rebase-vs-merge.md
thecodingdoc1 Jun 5, 2019
ec0abb5
Update
thecodingdoc1 Jun 6, 2019
8ec340d
Update strongbox-authorization-yaml.md
thecodingdoc1 Jun 6, 2019
f16bfd6
Revert "Update strongbox-authorization-yaml.md"
thecodingdoc1 Jun 6, 2019
e042280
Update strongbox-authorization-yaml.md
thecodingdoc1 Jun 6, 2019
9adec0d
Deleted TODO
thecodingdoc1 Jun 6, 2019
058e0b7
Update application-properties.md
thecodingdoc1 Jun 6, 2019
514c2d7
Removed TODO
thecodingdoc1 Jun 6, 2019
335838b
Corrections
thecodingdoc1 Jun 6, 2019
d1c8a10
Update artifact-query-language.md
thecodingdoc1 Jun 6, 2019
8bbbbb9
Grammer update
thecodingdoc1 Jun 6, 2019
f487dcb
Grammer updates
thecodingdoc1 Jun 6, 2019
ce8cd57
Update rebase-vs-merge.md
thecodingdoc1 Jun 10, 2019
54806e3
Update rebase-vs-merge.md
thecodingdoc1 Jun 10, 2019
f403623
Update artifact-query-language.md
thecodingdoc1 Jun 10, 2019
2beb706
Update artifact-query-language.md
thecodingdoc1 Jun 10, 2019
0cc5a76
Update artifact-query-language.md
carlspring Jun 10, 2019
61c915f
Update getting-started.md
thecodingdoc1 Jun 10, 2019
6f01e56
More minor grammar corrections
thecodingdoc1 Jun 10, 2019
6681ff2
Merge branch 'master' of https://github.com/thecodingdoc1/strongbox-docs
thecodingdoc1 Jun 10, 2019
53643ed
Update coding-convention.md
thecodingdoc1 Jun 10, 2019
259d9d9
Merge branch 'master' of https://github.com/thecodingdoc1/strongbox-docs
thecodingdoc1 Jun 10, 2019
9a2058c
Update docs/developer-guide/building-the-code-with-docker.md
thecodingdoc1 Jun 17, 2019
9f048da
Links
thecodingdoc1 Jun 17, 2019
ee09c7a
Comments
thecodingdoc1 Jun 17, 2019
f46675d
Merge branch 'master' of https://github.com/thecodingdoc1/strongbox-docs
thecodingdoc1 Jun 17, 2019
3411f00
Update coding-convention.md
thecodingdoc1 Jun 17, 2019
408105d
Update getting-started-with-persistence.md
thecodingdoc1 Jun 17, 2019
87f03ee
Update how-to-implement-spring-controllers.md
thecodingdoc1 Jun 17, 2019
4eca792
Update using-the-event-api.md
thecodingdoc1 Jun 17, 2019
5a2e2df
Link correction
thecodingdoc1 Jun 24, 2019
988ebc9
Update how-to-implement-your-own-repository-format.md
thecodingdoc1 Jun 24, 2019
4b6d64b
Update layout provider pages
thecodingdoc1 Jun 27, 2019
da43b5d
Update maven-metadata.md
thecodingdoc1 Jun 27, 2019
44f5fec
Updated and corrected links
thecodingdoc1 Jul 4, 2019
8d01ded
Update logging.md
thecodingdoc1 Jul 4, 2019
128d37e
Update maven-indexer.md
thecodingdoc1 Jul 4, 2019
bc9ac58
update
thecodingdoc1 Oct 2, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/developer-guide/building-the-code-with-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ However, things under Windows shouldn't be that different.

## Docker installation

Depending on your OS and distribution you can install different versions of Docker CE (Community Edition).
Depending on your OS and distribution, you can install different versions of Docker CE (Community Edition).
In most cases your distribution will have it's own package of Docker which works fine.

Please head to the docker [installation manual](https://docs.docker.com/install/) pages to check how to install it on your machine:
Expand Down Expand Up @@ -49,7 +49,7 @@ uid=1000(your-username) gid=1000(your-username) groups=1000(your-username)
```

If you see another `uid/gid` you will likely hit a permission issue. Unfortunately [docker/compose#3328][issue-3328],
[docker/compose#4700][issue-4700] and [docker/cli#1318][issue-1318] are preventing `docker-compose` from being able to
[docker/compose#4700][issue-4700], and [docker/cli#1318][issue-1318] are preventing `docker-compose` from being able to
thecodingdoc1 marked this conversation as resolved.
Show resolved Hide resolved
automatically fix the group id. There are two workarounds which you can apply for things to work as expected:

1. Instead of using `docker-compose`, you can use plain `docker` and pass ```--group-add `id -g` ``` to the arguments.
Expand Down Expand Up @@ -137,7 +137,7 @@ Our `.bashrc` has two types of commands which:
1. Start a container by mounting the current working directory as `workspace` (i.e `dockerMvn35`, `dockerGradle45`, etc)
2. Start a container and automatically clone a project from github and use that as the `workspace`. (i.e. `dockerMvn35Checkout`, `dockerGradle45Checkout`, etc)

If you don't remember arguments the command needs you can always execute `dockerMvn35 --help` and it will print them to you as well as an example.
If you don't remember arguments the command needs, you can always execute `dockerMvn35 --help` and it will print them to you as well as an example.

### Setting up `~/.bashrc`

Expand All @@ -151,7 +151,7 @@ echo "\$HOME/.bashrc-strongbox" >> ~/.bashrc
```

You can now either open up a new terminal or execute `source ~/.bashrc`
Have fun building things in docker :smile:
Have fun building things in docker! :smile:


### Example commands
Expand Down
4 changes: 2 additions & 2 deletions docs/developer-guide/building-the-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Then please make sure that:

* You don't have any other test in progress (e.g. halted by debugger process)

The reason for this failure is that OrientDB can't start, if another OrientDB process is running an listening on the same port.
The reason for this failure is that OrientDB can't start, if another OrientDB process is running and listening on the same port.

### Filename too long (Windows 7 and 10)

Expand All @@ -96,7 +96,7 @@ If you are getting one of these errors:


Then you are likely hitting a well-known issue with long paths under Windows.
Executing command below should fix the issue:
Executing the command below should fix the issue:

```
git config --system core.longpaths true
Expand Down
22 changes: 11 additions & 11 deletions docs/developer-guide/git/rebase-vs-merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Conceptual Overview

The first thing to understand about `git rebase` is that it solves the same problem as git merge. Both of these commands
are designed to integrate changes from one branch into another branch—they just do it in very different ways.
are designed to integrate changes from one branch into another branch. They just do it in very different ways.

Consider what happens when you start working on a new feature in a dedicated branch, then another team member updates
the `master` branch with new commits. This results in a forked history, which should be familiar to anyone who has used
Expand All @@ -18,7 +18,7 @@ new commits into your `feature` branch, you have two options: `merging` or `reba

??? danger "Please avoid using this option!"
Please avoid using this option. It creates unnecessary noise in your PRs and makes it ***extremely*** hard to
follow your real changes. We have included this information because it will give you better understanding of why we
follow your real changes. We have included this information because it will give you a better understanding of why we
prefer `rebasing` over `merging`.

The easiest option is to merge the `master` branch into the feature branch using something like the following:
Expand Down Expand Up @@ -51,15 +51,15 @@ to understand the history of the project or branch you are working on.

!!! success "We prefer this option over `merging`"

As an alternative to merging, you can rebase the feature branch onto master branch using the following commands:
As an alternative to merging, you can rebase the feature branch onto the master branch using the following commands:

```
git checkout feature
git rebase master
```

This moves the entire `feature` branch to begin on the tip of the master branch, effectively incorporating all of
the new commits in `master`. But, instead of using a `merge` commit, `rebasing` re-writes the project history by
the new commits in `master`. Instead of using a `merge` commit, `rebasing` re-writes the project history by
creating brand new commits for each commit in the original branch.

![](images/03.svg)
Expand Down Expand Up @@ -97,7 +97,7 @@ However, before executing this command, please be **sure** nobody else is workin
## But how do I rebase?

Before you start, it is a good idea to backup your current project. If this is your first time doing a rebase, you can
screw things up and loose/damage the work you've already done. So better safe, than sorry. (If you are a pro - what are
screw things up and lose/damage the work you've already done. So better safe than sorry. (If you are a pro - what are
you even doing here? :smile: )


Expand All @@ -114,10 +114,10 @@ Steps:
```linenums="1"
$ git remote add upstream [email protected]:strongbox/strongbox.git
$ git remote -v
origin [email protected]:your-username/strongbox.git (fetch)
origin [email protected]:your-username/strongbox.git (push)
upstream [email protected]:strongbox/strongbox.git (fetch)
upstream [email protected]:strongbox/strongbox.git (push)
origin [email protected]:your-username/strongbox.git (fetch)
origin [email protected]:your-username/strongbox.git (push)
upstream [email protected]:strongbox/strongbox.git (fetch)
upstream [email protected]:strongbox/strongbox.git (push)
```

* Sync your fork
Expand Down Expand Up @@ -156,7 +156,7 @@ You can also check Idea's manual for [Resolving Conflicts]

#### Command line

If you are command line lover, you can execute the commands manually:
If you are a command line lover, you can execute the commands manually:

```linenums="1"
git checkout feature-branch
Expand All @@ -167,7 +167,7 @@ However, when conflicts arise, it could be a bit challenging to fix them from yo

#### Finally

Once you are done rebasing and you have ensured that the code builds as well as the tests are passing, then you will
Once you are done rebasing and you have ensured that the code builds and the tests are passing, then you will
need to force push your branch (remember the [Force Pushing](#force-pushing) section?)

```
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/application-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The following is a list of configuration properties, which can be used to custom

??? info "export STRONGBOX_DOWNLOAD_INDEXES_\${storageId}\_\* or <br> -Dstrongbox.download.indexes_\${storageId}_*"

Whether, or not to download the Maven indexes for all remote repositories in the `$storageId`.
Whether to download the Maven indexes for all remote repositories in the `$storageId`.

Can be passed as `-Dstrongbox.download.indexes_${storageId}_*` or set via the env variable `STRONGBOX_DOWNLOAD_INDEXES_${storageId}_*`

Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/artifact-query-language.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ needs to work the same across all layouts:

### Values

* _**Values**_ can be strings:
* _**Values**_ can be strings

* Quoted with single quotes `'` when the value is more than one word (for example: `storage: storage0`, `layout: 'Maven 2'`)
* Separated with comma `,` for multiple values; you can consider this the same as `IN` operator in SQL (for example: `repository: releases, snapshots`, `layout: 'Maven 2', NuGet`)
* Separated by a comma `,` for multiple values; you can consider this the same as `IN` operator in SQL (for example: `repository: releases, snapshots`, `layout: 'Maven 2', NuGet`)
* Wildcards are supported `*` (for example: `group: org.carlspring.*`)

* _**Values**_ can be dates in Unicode format: `2018-03-21 13:00:00`, `2018-03-21` (for example: `updated: 2018-03-21`, `updated: '2018-03-21 13:00'`)
Expand Down Expand Up @@ -94,7 +94,7 @@ needs to work the same across all layouts:

## How to use

The easiest way to AQL is by using the search bar in the user interface. Once you start writing, you will see suggestions
The easiest way to use the AQL is by using the search bar in the user interface. Once you start writing, you will see suggestions
based on what you've typed. You could also directly search via the REST API Endpoint.

Example `curl` request:
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/artifact-routing-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Example:

### Denied Patterns

* The following example disable lookups for `.*(com|org)/carlspring.*` in the group repository identified by `storage-id` equal to `storage-common-proxies` and `repository-id` equal to `group-common-proxies` in the underlying repository identified by `storage-id` equal to `storage-common-proxies` and `repository-id` equal to `jboss-public-releases`.
* The following example disables lookups for `.*(com|org)/carlspring.*` in the group repository identified by `storage-id` equal to `storage-common-proxies` and `repository-id` equal to `group-common-proxies` in the underlying repository identified by `storage-id` equal to `storage-common-proxies` and `repository-id` equal to `jboss-public-releases`.

To put it more simply, if someone tries to access `.*(com|org)/carlspring.*` from group repository `storage-id="storage-common-proxies" repository-id="group-common-proxies"` then this group repository won't serve this request from repository `storage-id="storage-common-proxies" repository-id="jboss-public-releases"`, for sure.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Below is a simple scrap of the `strongbox-authorization.yaml` configuration file

# Anonymous User Privileges

There is a special treatment role called **`ANONYMOUS_ROLE`** that is not considered as a [built-in role](http://TODO_link_to_roles) so it doesn't have a fixed set of permissions. Anonymous user's privileges are configurable and can be defined in the `strongbox-authorization.yaml` configuration file.
There is a special treatment role called **`ANONYMOUS_ROLE`** that is not considered as a (link not completed) [built-in role](http://TODO_link_to_roles) so it doesn't have a fixed set of permissions. Anonymous user's privileges are configurable and can be defined in the `strongbox-authorization.yaml` configuration file.

authorizationConfiguration:
roles:
Expand All @@ -43,7 +43,7 @@ This way every user not logged in will be awarded by the `ARTIFACTS_RESOLVE` and

The following classes are related to various aspects of the authorization configuration:

| Class Name | Description |
| Class Name | Description |
|:------------|-------------|
| [`org.carlspring.strongbox.authorization.dto.AuthorizationConfigDto`](https://github.com/strongbox/strongbox/blob/master/strongbox-security/strongbox-user-management/src/main/java/org/carlspring/strongbox/authorization/dto/AuthorizationConfigDto.java) | Represents authorization configuration in a deserialized form. |
| [`org.carlspring.strongbox.authorization.AuthorizationConfigFileManager`](https://github.com/strongbox/strongbox/blob/master/strongbox-security/strongbox-user-management/src/main/java/org/carlspring/strongbox/authorization/AuthorizationConfigFileManager.java) | Class to serialize / deserialize the authorization configuration. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This file is read by the system at the server startup time and it automatically

For an example, check [here](https://github.com/strongbox/strongbox/blob/master/strongbox-cron/strongbox-cron-api/src/main/resources/etc/conf/strongbox-cron-tasks.yaml)

Every cron task configuration is an `cronTaskConfigurations` array element. Inner properties are:
Every cron task configuration is a `cronTaskConfigurations` array element. Inner properties are:

* `uuid`: identifies the individual cron task configuration in the system

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The `strongbox-security-users.yaml` File

TODO @sbespalov

thecodingdoc1 marked this conversation as resolved.
Show resolved Hide resolved

# Example `strongbox-security-users.yaml` File

Expand Down Expand Up @@ -69,7 +69,7 @@ The `access-model` element is optional.

### Configuring The User Access Model

TODO @sbespalov

thecodingdoc1 marked this conversation as resolved.
Show resolved Hide resolved

## Information for Developers

Expand Down
6 changes: 3 additions & 3 deletions docs/user-guide/directory-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Strongbox Distribution

When you download and extract `strongbox-distribution.tar.gz` you will find the following directory structure:
When you download and extract `strongbox-distribution.tar.gz`, you will find the following directory structure:

### Directory structure

Expand All @@ -23,15 +23,15 @@ When you download and extract `strongbox-distribution.tar.gz` you will find the

The vault is the work area of the server. This includes things like the cache, location of the OrientDB files,
storages and temporary directory. You can find this directory right next to where `strongbox-distribution` is located
(in other words - `strongbox-distribution/../strongbox-vault`). Check the [Application Properties](/user-guide/application-properties.md)
(in other words - `strongbox-distribution/../strongbox-vault`). Check the [Application Properties](./user-guide/application-properties.md)
thecodingdoc1 marked this conversation as resolved.
Show resolved Hide resolved
section to see which property to override to change the default location.

### Directory structure

* `strongbox-vault/`
* `cache/`
* `db/`
* [storages](/knowledge-base/storages/)/
* [storages](../../knowledge-base/storages.html)/
thecodingdoc1 marked this conversation as resolved.
Show resolved Hide resolved
* `${storageId}/`
* `${repositoryId}/`
* [.index/](../developer-guide/maven-indexer.md#where-are-the-maven-indexes-located)
Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ tar -zxf /path/to/strongbox-distribution*.tar.gz \
-C /opt/strongbox \
--strip-components=2

# If you just want to start Strongbox without installing the systemd service:
# If you just want to start Strongbox without installing the system service:
thecodingdoc1 marked this conversation as resolved.
Show resolved Hide resolved

/opt/strongbox/bin/strongbox console

# If you want to install Strongbox as a service then download the
# systemd service file. Make sure to change the `Environment` variables
# system service file. Make sure to change the `Environment` variables
thecodingdoc1 marked this conversation as resolved.
Show resolved Hide resolved
# in the service file where necessary. Depending on your distribution,
# you could also move the environment variables into `EnvironmentFile`
# and load that instead.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/ui/system-information.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# System Information

This module provides information about the environment where Strongbox is currently running.
To make your live easier, we've included a `search` filter so that you can find what you're looking for faster.
To make your life easier, we've included a `search` filter so that you can find what you're looking for faster.

## JVM Arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/ui/user-management.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## Intro

The user management module allows you to list/add/update/delete users fine-tune their access level to Strongbox.
The user management module allows you to list/add/update/delete users and fine-tune their access level to Strongbox.

<img src="/assets/screenshots/08-user-management.png" data-zoomable="true" />

## Access Model

TODO: Add mode information about this later. (SB-1339; SB-1285)
thecodingdoc1 marked this conversation as resolved.
Show resolved Hide resolved

4 changes: 2 additions & 2 deletions docs/user-guide/upgrading.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Upgrading Strongbox

We try to test everything as through as possible. However Strongbox is still under development and sometimes things
could go wrong. This is why
We try to test everything as thorough as possible. However, Strongbox is still under development and sometimes things
could go wrong. This is why:

!!! danger
**YOU SHOULD ALWAYS CREATE A BACKUP OF YOUR [`STRONGBOX_VAULT`](./application-properties.md) and
Expand Down