Skip to content

Commit

Permalink
fix(doc-links): use https, harmonize url formats, linkify text-only u…
Browse files Browse the repository at this point in the history
…rls, codify example urls (opf#10374)
  • Loading branch information
as-op authored Mar 23, 2022
1 parent 1859591 commit 37e6f97
Show file tree
Hide file tree
Showing 43 changed files with 87 additions and 99 deletions.
2 changes: 1 addition & 1 deletion docs/development/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Project maintainers have the right and responsibility to remove, edit, or reject

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This code of conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/
This code of conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.0.0, available at [contributor-covenant.org/version/1/0/0/](https://www.contributor-covenant.org/version/1/0/0/)



Expand Down
6 changes: 3 additions & 3 deletions docs/development/code-review-guidelines/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ The reviewer should understand the code without explanations outside the code.

## Citations

http://scientopia.org/blogs/goodmath/2011/07/06/things-everyone-should-do-code-review/
[scientopia.org/blogs/goodmath/2011/07/06/things-everyone-should-do-code-review/](https://blog.csdn.net/zhangmike/article/details/30198411)

http://beust.com/weblog/2006/06/22/why-code-reviews-are-good-for-you/
[beust.com/weblog/2006/06/22/why-code-reviews-are-good-for-you/](https://beust.com/weblog/2006/06/22/why-code-reviews-are-good-for-you/)

https://developer.mozilla.org/en/Code_Review_FAQ
[www-archive.mozilla.org/hacking/code-review-faq](https://www-archive.mozilla.org/hacking/code-review-faq)
2 changes: 1 addition & 1 deletion docs/development/concepts/hal-resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,5 +237,5 @@ In order to turn the JSON properties from `_embedded` and `_links` into writable

## Discussions

- Due to the dynamic properties of the HAL resource, it traditionally has an index map to `any` which is the source of many typing issues and in turn, quite a number of bugs: https://github.com/opf/openproject/blob/76823ca58179a87afbb5fc0925c3453780dec381/frontend/src/app/modules/hal/resources/hal-resource.ts#L56-L60
- Due to the dynamic properties of the HAL resource, it traditionally has an index map to `any` which is the source of many typing issues and in turn, quite a number of bugs: [hal-resource.ts](https://github.com/opf/openproject/blob/76823ca58179a87afbb5fc0925c3453780dec381/frontend/src/app/modules/hal/resources/hal-resource.ts#L56-L60)
- The way HAL resources work by embedding and allowing to load
2 changes: 1 addition & 1 deletion docs/development/concepts/inline-editing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ In order to understand the different modes of the inline edition functionality,

The display fields handle showing read-only representation of a resource's attribute. For example, the work package table may contain very different kinds of attributes: A progress bar, bare text fields, formatted date fields and the like.

Since OpenProject can also have dynamic custom fields with varying formats, the frontend cannot know all potential attribute names and their types. Instead, the available attributes of a resource are retrieved from its associated [schema resource](../resource-schemas/). For display fields, the important part of the schema definition for an attribute is its `type` attribute. Take a look at the JSON schema response for projects at the community: https://community.openproject.com/api/v3/projects/schema. For the sake of brevity, the following JSON will only show two of the returned attributes: The name and status attribute description:
Since OpenProject can also have dynamic custom fields with varying formats, the frontend cannot know all potential attribute names and their types. Instead, the available attributes of a resource are retrieved from its associated [schema resource](../resource-schemas/). For display fields, the important part of the schema definition for an attribute is its `type` attribute. Take a look at the JSON schema response for projects at the community: [community.openproject.com/api/v3/projects/schema](https://community.openproject.com/api/v3/projects/schema). For the sake of brevity, the following JSON will only show two of the returned attributes: The name and status attribute description:

```json
"name": {
Expand Down
4 changes: 2 additions & 2 deletions docs/development/concepts/queries/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ These filters are also saved within the queries. If you would like to read more

### Exemplary query response

Due to the public nature of the OpenProject community, you can check out the following exemplary query response in HAL+JSON: http://community.openproject.com/api/v3/queries/2453
Due to the public nature of the OpenProject community, you can check out the following exemplary query response in HAL+JSON: [community.openproject.com/api/v3/queries/2453](https://community.openproject.com/api/v3/queries/2453)

It returns a saved query for the OpenProject 11.0 release, with a type filter `type is not [Idea, Phase, Release]` , a version filter `version = 11.0.0` and a "show all subprojects" filter with `subProject = all` . It is sorted by `type ascending`.

Expand Down Expand Up @@ -176,7 +176,7 @@ In practice, you will likely not only access the query resource itself, but rath

The `WorkPackagesListService` can also update and save existing queries passed to it. This flow will often happen in the [`PartitionedQuerySpaceComponent`](https://github.com/opf/openproject/tree/dev/frontend/src/app/modules/work_packages/routing/partitioned-query-space-page/partitioned-query-space-page.component.ts), which is the basis for the modules showing work packages as a table or grid such as the [`WorkPackageViewPageComponent`](https://github.com/opf/openproject/tree/dev/frontend/src/app/modules/work_packages/routing/wp-view-page/wp-view-page.component.ts) or the [`IfcViewerPageComponent`](https://github.com/opf/openproject/tree/dev/frontend/src/app/modules/bim/ifc_models/pages/viewer/ifc-viewer-page.component.ts).

`PartionedQuerySpaceComponent` instances will be instantiated by the router and listen to URL params to load the corresponding query object. The most prominent example of such a page is the work packages module such as https://community.openproject.com/work_packages.
`PartionedQuerySpaceComponent` instances will be instantiated by the router and listen to URL params to load the corresponding query object. The most prominent example of such a page is the work packages module such as [community.openproject.com/work_packages](https://community.openproject.com/work_packages).

The partitioning comes from showing a work package table (or cards view) on one side, and a details view of a single work package on another side, splitting the page in two. The width of the split areas can be customized by the user through a drag-handle.

6 changes: 3 additions & 3 deletions docs/development/concepts/resource-schemas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ This section describes some of the existing schemas.

**Projects**

For projects, there is a single APIv3 endpoint for their schemas: `/api/v3/projects/schema`. This schema is identical for all projects. You can simply request the OpenProject Community schema for projects here: https://community.openproject.com/api/v3/projects/schema. It contains a set of static properties (name, identifier, status, etc.), as well as all project-level custom fields.
For projects, there is a single APIv3 endpoint for their schemas: `/api/v3/projects/schema`. This schema is identical for all projects. You can simply request the OpenProject Community schema for projects [here](https://community.openproject.com/api/v3/projects/schema). It contains a set of static properties (name, identifier, status, etc.), as well as all project-level custom fields.



Expand All @@ -84,7 +84,7 @@ The work package schema is more complicated, as work package types can be custom

This results in work package schemas being defined per project and type combination. The URL of each schema looks like this: `/api/v3/work_packages/schemas/{project id}-{type-id}`.

An exemplary schema response on the Community for the OpenProject project (`ID=14`) and the Bug type (`ID=1`) is https://community.openproject.com/api/v3/work_packages/schemas/14-1
An exemplary schema response on the Community for the OpenProject project (`ID=14`) and the Bug type (`ID=1`) is [community.openproject.com/api/v3/work_packages/schemas/14-1](https://community.openproject.com/api/v3/work_packages/schemas/14-1)

The work package schema also contains the reference to the attribute groups from the form configuration in the `_attributeGroups` property.

Expand All @@ -96,7 +96,7 @@ The OpenProject frontend usually ensure that whenever you get access to a HAL re

In some cases, such as the work package `/api/v3/work_packages` or `/api/v3/queries` endpoints, the needed schemas to represent the work packages contained in the collection are embedded automatically in the `_embedded.schemas` endpoint. Services handling these loaded requests such as the [`WorkPackagesStatesIntializationService`](https://github.com/opf/openproject/blob/dev/frontend/src/app/components/wp-list/wp-states-initialization.service.ts#L97-L101) will automatically update the schema states.

If you look at the HAL+JSON response of a work package API request, you will see it has a `_links.schema.href` property which identifies the schema resource that the loaded work package is associated with. (Exemplary request: http://community.openproject.com/api/v3/work_packages/34250)
If you look at the HAL+JSON response of a work package API request, you will see it has a `_links.schema.href` property which identifies the schema resource that the loaded work package is associated with. ([Exemplary request](https://community.openproject.com/api/v3/work_packages/34250))

If you have work package resource, you can get hold of its associated schema as follows:

Expand Down
4 changes: 2 additions & 2 deletions docs/development/concepts/translations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ expect(page).to have_selector('button', text: I18n.t('work_packages.my_specific_



The Rails guide on translations will give advanced examples on variable interpolation and the like: https://guides.rubyonrails.org/i18n.html
The Rails guide on translations will give advanced examples on variable interpolation and the like: [guides.rubyonrails.org/i18n](https://guides.rubyonrails.org/i18n.html)



Expand Down Expand Up @@ -127,4 +127,4 @@ Then you can use them as below in your template:



For more information on formatting and other helpers of the `I18n.js` library, see https://github.com/fnando/i18n-js
For more information on formatting and other helpers of the `I18n.js` library, see [github.com/fnando/i18n-js](https://github.com/fnando/i18n-js)
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If you have any questions on the contribution process or encounter problems with

1. Login to or register at the [OpenProject community platform](https://community.openproject.org/login). It’s fast and free.

2. Open a new [documentation work package]( https://community.openproject.org/projects/openproject/work_packages/new?type=69).
2. Open a new [documentation work package](https://community.openproject.org/projects/openproject/work_packages/new?type=69).

3. Add a precise subject.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Redirects are managed in a repository that is not accessible by the OpenProject

2. Check if there is already an existing ticket by using the search bar in the header navigation at the top. If there is one, please leave a comment or add additional information. Otherwise:

3. Open a new [documentation work package]( https://community.openproject.org/projects/openproject/work_packages/new?type=69)
3. Open a new [documentation work package](https://community.openproject.org/projects/openproject/work_packages/new?type=69)

4. Add a precise subject.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Within each folder there is a sub-hierarchy of topics. E.g. in the Getting start

### Folder content

We aim to have a clear hierarchical structure with meaningful URLs like https://www.openproject.org/docs/getting-started/sign-in-registration/. With this structure you can identify straight away that this part of the documentation is about the sign in and registration process. At the same time, the website path matches our repository, making it easy to update the documentation.
We aim to have a clear hierarchical structure with meaningful URLs like `https://www.openproject.org/docs/getting-started/sign-in-registration/`. With this structure you can identify straight away that this part of the documentation is about the sign in and registration process. At the same time, the website path matches our repository, making it easy to update the documentation.

Find an overview of content per folder here:

Expand Down
4 changes: 2 additions & 2 deletions docs/development/create-openproject-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ It is probably best to use READMEs of already released plugins as a template.
- Ensure gemspec fields are complete and version number is correct
- `gem build <name>.gemspec`
- `gem push <name>-<version>.gem`. This asks for your user/password
- Go to https://rubygems.org, log in, go to the dashboard, click on the uploaded gem, click edit. Set URLs, at least source code URL and Bug Tracker URL
- Go to [rubygems.org](https://rubygems.org), log in, go to the dashboard, click on the uploaded gem, click edit. Set URLs, at least source code URL and Bug Tracker URL
- You are done .
- *Be careful when publishing a gem.Once it is published, it cannot be replaced in the same version*. It is only possible to take a version out of the index and publish a new version.
- *Be careful when publishing a gem. Once it is published, it cannot be replaced in the same version*. It is only possible to take a version out of the index and publish a new version.

### Create public visibility

Expand Down
4 changes: 2 additions & 2 deletions docs/development/development-environment-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ bin/compose setup
bin/compose start
```

Once the containers are done booting you can access the application under http://localhost:3000.
Once the containers are done booting you can access the application under `http://localhost:3000`.

### Tests

Expand Down Expand Up @@ -104,7 +104,7 @@ However, these are cached in a docker volume. Meaning that from the 2nd run onwa

Wait until you see `frontend_1 | : Compiled successfully.` and `backend_1 | => Rails 6.0.2.2 application starting in development http://0.0.0.0:3000` in the logs.
This means both frontend and backend have come up successfully.
You can now access OpenProject under http://localhost:3000, and via the live-reloaded under http://localhost:4200.
You can now access OpenProject under `http://localhost:3000`, and via the live-reloaded under `http://localhost:4200`.

Again the first request to the server can take some time too.
But subsequent requests will be a lot faster.
Expand Down
8 changes: 3 additions & 5 deletions docs/development/development-environment-osx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ $ nodenv init

### Install latest LTS node version

You can find the latest LTS version here: https://nodejs.org/en/download/
You can find the latest LTS version here: [nodejs.org/en/download](https://nodejs.org/en/download/)

At the time of writing this is v14.17.0. Install and activate it with:

Expand Down Expand Up @@ -195,14 +195,14 @@ gem install foreman
foreman start -f Procfile.dev
```
The application will be available at `http://127.0.0.1:5000`. To customize bind address and port copy the `.env.example` provided in the root of this
project as `.env` and [configure values][foreman-env] as required.
project as `.env` and [configure values](https://ddollar.github.io/foreman/#ENVIRONMENT) as required.

By default a worker process will also be started. In development asynchronous execution of long-running background tasks (sending emails, copying projects,
etc.) may be of limited use. To disable the worker process:

echo "concurrency: web=1,assets=1,worker=0" >> .foreman

For more information refer to Foreman documentation section on [default options][foreman-defaults].
For more information refer to Foreman documentation section on [default options](https://ddollar.github.io/foreman/#DEFAULT-OPTIONS).

You can access the application with the admin-account having the following credentials:

Expand Down Expand Up @@ -251,5 +251,3 @@ If an error occurs, it should be logged there (as well as in the output to STDOU
If you have any further questions, comments, feedback, or an idea to enhance this guide, please tell us at the appropriate community.openproject.org [forum](https://community.openproject.org/projects/openproject/boards/9).
[Follow OpenProject on twitter](https://twitter.com/openproject), and follow [the news](https://www.openproject.org/blog) to stay up to date.

[foreman-defaults]:http://ddollar.github.io/foreman/#DEFAULT-OPTIONS
[foreman-env]:http://ddollar.github.io/foreman/#ENVIRONMENT
11 changes: 4 additions & 7 deletions docs/development/development-environment-ubuntu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ git clone https://github.com/nodenv/node-build.git $(nodenv root)/plugins/node-b

### Install latest LTS node version

You can find the latest LTS version here: https://nodejs.org/en/download/
You can find the latest LTS version here: [nodejs.org/en/download/](https://nodejs.org/en/download/)

At the time of writing this is v16.13.1 Install and activate it with:

Expand Down Expand Up @@ -176,7 +176,7 @@ npm --version
In order to create a pull request to the core OpenProject repository, you will want to fork it to your own GitHub account.
This allows you to create branches and push changes and finally opening a pull request for us to review.

To do that, go to https://github.com/opf/openproject and press "Fork" on the upper right corner.
To do that, go to [github.com/opf/openproject](https://github.com/opf/openproject) and press "Fork" on the upper right corner.

```bash
# Download the repository
Expand Down Expand Up @@ -246,14 +246,14 @@ gem install foreman
foreman start -f Procfile.dev
```
The application will be available at `http://127.0.0.1:3000`. To customize bind address and port copy the `.env.example` provided in the root of this
project as `.env` and [configure values][foreman-env] as required.
project as `.env` and [configure values](https://ddollar.github.io/foreman/#ENVIRONMENT) as required.

By default a worker process will also be started. In development asynchronous execution of long-running background tasks (sending emails, copying projects,
etc.) may be of limited use. To disable the worker process:

echo "concurrency: web=1,assets=1,worker=0" >> .foreman

For more information refer to Foreman documentation section on [default options][foreman-defaults].
For more information refer to Foreman documentation section on [default options](https://ddollar.github.io/foreman/#DEFAULT-OPTIONS).

You can access the application with the admin-account having the following credentials:

Expand Down Expand Up @@ -300,6 +300,3 @@ If an error occurs, it should be logged there (as well as in the output to STDOU

If you have any further questions, comments, feedback, or an idea to enhance this guide, please tell us at the appropriate community.openproject.org [forum](https://community.openproject.org/projects/openproject/boards/9).
[Follow OpenProject on twitter](https://twitter.com/openproject), and follow [the news](https://www.openproject.org/blog) to stay up to date.

[foreman-defaults]:http://ddollar.github.io/foreman/#DEFAULT-OPTIONS
[foreman-env]:http://ddollar.github.io/foreman/#ENVIRONMENT
4 changes: 2 additions & 2 deletions docs/development/git-workflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ keywords: development workflow, gitflow, git flow

This guide will introduce you to how we at OpenProject develop OpenProject with Git, and how to contribute code. For other ways on how to contribute to OpenProject, [please see the contribution guide](../#contributor-code-of-conduct).

The OpenProject core is developed fully at our GitHub repository at https://github.com/opf/openproject. In the course of this guide, we assume that you are familiar with Git. If you need a refresher on certain topics, we recommend the [free Pro Git online book](https://git-scm.com/book/en/v2) as a resource for all topics on Git.
The OpenProject core is developed fully at our [GitHub repository](https://github.com/opf/openproject). In the course of this guide, we assume that you are familiar with Git. If you need a refresher on certain topics, we recommend the [free Pro Git online book](https://git-scm.com/book/en/v2) as a resource for all topics on Git.



Expand Down Expand Up @@ -49,7 +49,7 @@ The basic overview of how to contribute code to OpenProject is as follows.

For contributing source code, please follow the git workflow below:

- Use GitHub UI to fork the [OpenProject repository](https://github.com/opf/openproject) https://github.com/opf/openproject.
- Use GitHub UI to fork the [OpenProject repository](https://github.com/opf/openproject).
- Clone your fork to your development machine:

```
Expand Down
Loading

0 comments on commit 37e6f97

Please sign in to comment.