Redirect guidelines #15
Conversation
Addition of the files "REDIRECT.md" and "REDIRECT.en.md" in order to give rules about the redirection of URI with w3id.org. Minor changes to existing documentation files.
Minor changes
Minor changes
Minor corrections on the text of the markdown files
- adding a document that describes the process that every Organization must follow in order to configure the redirect of the resources' URIs with w3id. - alignment of this guide with the concepts expressed into the cookiecutter repository (teamdigitale/dati-semantic-cookiecutter#15).
REDIRECT.en.md
Outdated
| <pre> | ||
| italia |
There was a problem hiding this comment.
Consistently use ``` instead of <pre>
There was a problem hiding this comment.
Can you please suggest where we should put ``` instead of
REDIRECT.en.md
Outdated
| # Guide to URI redirection | ||
|
|
||
| This document provides guidance for creating and publishing | ||
| `htaccess` files that allow redirection of semantic resources | ||
| URIs using the w3id. | ||
|
|
There was a problem hiding this comment.
If this document is sourced from the w3id.org, consider linking,
so that if the w3id.org rules change, we don't need to update our docs
There was a problem hiding this comment.
The guide in REDIRECT.en.md (and in REDIRECT.md) is a sort of specialization of the w3id guide for the Italia usecase. In other words, we based our guide on the w3id one, but they are different things. We can express this concept better on our redirect files.
Thanks.
There was a problem hiding this comment.
The last commit fixes this.
CONTRIBUTING.en.md
Outdated
| @@ -11,7 +11,7 @@ The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "S | |||
| in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, | |||
| and only when, they appear in all capitals, as shown here. | |||
|
|
|||
| ## Required files and directory layout | |||
| ## Required files and repository layout | |||
There was a problem hiding this comment.
nitpicking ;)
- repository layout := required files + directory layout
There was a problem hiding this comment.
The last commit fixes this.
|
Hi @ioggstream, Thanks for your review. I'm going to integrate your suggestions to the PR. Anyway, we are going to publish soon the new version of the NDC guide on another repository. In order to avoid redundancy, we will link the latter guide from the readmes of this repository, instead of rewriting same things. So, Thanks. CC: @Clou-dia |
accepting the suggestion from @ioggstream Co-authored-by: Roberto Polli <[email protected]>
Co-authored-by: Roberto Polli <[email protected]>
Editorial improvements
|
I close this PR because it's obsolete. I'm going to update the readme files of cookiecutter in order to link the updated version of the NDC guide deployed here: https://github.com/teamdigitale/dati-semantic-guida-ndc-docs |
Provide a guideline in italian and english regarding the redirect configuration of the URIs using the w3id git.