1
1
Permanent Identifiers for the Web
2
2
=================================
3
3
4
+ [ ![ Build Status] ( https://travis-ci.org/perma-id/w3id.org.svg )] ( https://travis-ci.org/perma-id/w3id.org )
5
+
4
6
This repository holds the website source code for https://w3id.org/
5
7
6
8
The purpose of w3id.org is to provide a secure, permanent URL re-direction
@@ -44,11 +46,16 @@ Adding a Permanent Identifier to w3id.org
44
46
For the technically savvy, the preferred way to create the redirect yourself is
45
47
by following these steps:
46
48
47
- 1 . Fork this source code repository.
48
- 2 . Add a new re-direct entry. Look in the '/security/.htaccess' file for a
49
- simple example.
50
- 3 . Commit your changes and submit a pull request.
51
- 4 . w3id.org administrators will review your pull request and merge it if
49
+ 1 . Fork the [ perma-id/w3id.org] ( https://github.com/perma-id/w3id.org )
50
+ source code repository.
51
+ 2 . Add a new re-direct entry. For a simple example, see
52
+ [ security/.htaccess] ( security/.htaccess )
53
+ 3 . (Optional) Add a ` README.md ` detailing contact persons and
54
+ (a subset of) your permanent identifiers. For an example,
55
+ see [ rdw/README.md] ( rdw/README.md )
56
+ 4 . Commit your changes and submit a
57
+ [ pull request] ( https://github.com/perma-id/w3id.org/pulls ) .
58
+ 5 . w3id.org administrators will review your pull request and merge it if
52
59
everything looks correct. Once the pull request is merged, the changes go
53
60
live immediately.
54
61
@@ -57,3 +64,21 @@ You can also send a request to add a redirect to the
57
64
mailing list. Make sure to include the URL that you want on w3id.org, the
58
65
URL that you want to redirect to, and the HTTP code that you want to use
59
66
when redirecting. An administrator will then create the redirect for you.
67
+
68
+ Link checking
69
+ -------------
70
+ A simple [ Travis-CI] ( https://travis-ci.org/perma-id/w3id.org ) job
71
+ (see [ .travis.yml] ( .travis.yml ) ) will extract all https://w3id.org/
72
+ URIs from ` */README.md ` and check them with
73
+ [ linkchecker] ( https://wummel.github.io/linkchecker/ ) -
74
+ in theory this will catch two kinds of errors:
75
+
76
+ 1 . Following a redirection gives a ` 404 Not Found `
77
+ 2 . An error in ` .htaccess ` causes a ` 500 Server Error ` .
78
+
79
+ Note that this only checks URIs that are listed in the ` README.md ` files.
80
+
81
+ Travis might comment on your Pull Request if this test reveals an error -
82
+ check its output logs to ensure the errors are not caused by
83
+ your modification.
84
+
0 commit comments