settermjd
commented
5 years ago I ran the following bash one-liner over all the docs and extracted the below list of domain names.
grep -rioP --no-filename 'https?:\/{2}(?:[\/\-\w.]|(?:%[\da-fA-F]{2}))+' \
./modules/*_manual/pages --include="*.adoc" \
| sort | awk -F/ '{print $3}' | uniq172.16.40.100
172.17.0.1
192.168.10.50
acme.com
admin
bucket.hostname.domain
domain.tld
example.com
example.org
foo.com
foo.example.org
hostname.domain
localhost
mycloud.example.com
mycloud.org
myown.server
myserver
myserver.example.com
newinstance.com
server
test.example.com
www.example.com
www.example.org
www.foo.com
your-domain.com
your.office.online.server.tld
your.owncloud.install.com
your_domain
yourserver.comI'm happy to standardise around example.com (or some variation on that), as it's non-routable and commonly used. Thoughts @mmattel @phil-davis?
phil-davis
mmattel
Describe, in detail, what changes are required.
Standardize how example domains are written. For details please see: https://github.com/owncloud/docs/pull/764 and https://github.com/owncloud/docs/pull/764/files
Where Does This Need To Be Documented?
Review of the whole documentation set.
Why Should This Change Be Made? (Optional)
If you run a broken link checker eg
yarn linkcheck(see our documentation), you get a huge quantity of false-positives because of example links. We could exclude these linke with exclude directives but then we have to standardize and minimize the quantity of examples.What Type Of Content Change Is This? (Optional)
Which Manual Does This Relate To? (Optional)
@settermjd @tboerger @PVince81 @phil-davis