Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Align page and file names #179

Merged
merged 2 commits into from
Dec 4, 2017
Merged

Conversation

handrews
Copy link
Contributor

It has long annoyed me that our page names and filenames don't
match. I open specification-links.md when I mean to open
documentation.md probably half the time at least.

I decided that I prefer "Specification" over "Documentation"
and "Implementations" over "Software", but that's definitely
open to discussion.

  • Update "gems" to "plugins" to get jekyll to stop complaining
  • Add the redirect plugin
  • Rename documentation.md to specification.md and add a redirect
  • Change the title of implementations.md to Implementations

Remove most remaining links to ".md" URIs and standardize on
".html" which seems to be what we've been going for. I think
there are still example links with ".md" but I did not want
to touch the examples at all for now.

@adamvoss let me know if this will mess up anything you're doing
with analytics. Or perhaps we should just take stock of what the
analytics have told us so far and then feel free to change things?

It has long annoyed me that our page names and filenames don't
match.  I open specification-links.md when I mean to open
documentation.md probably half the time at least.

* Update "gems" to "plugins" to get jekyll to stop complaining
* Add the redirect plugin
* Rename documentation.md to specification.md and add a redirect
* Change the title of implementations.md to Implementations

Remove most remaining links to ".md" URIs and standardize on
".html" which seems to be what we've been going for.  I think
there are still example links with ".md" but I did not want
to touch the examples at all for now.
While there's not much we can do with the .txt or .xml files in
the top level directory right now, we can make the .html use
a redirect so we can put it in its draft-NN directory as we
do with the more recent drafts.

For the .txt and .xml files, while you can get Jekyll to process
them, the redirect plugin is implented by emitting an HTML file
with a canonical link header, as there is no access to the web
server itself to respond with an HTTP redirect code.
@handrews handrews merged commit 935a2c9 into json-schema-org:master Dec 4, 2017
@handrews handrews deleted the cleanup branch May 22, 2018 23:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants