solid / solid/specification

Management of github.io spec URLs after transition

Open
#215 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

category: question doc: Ecosystem
Dominant language
HTML
Stars
563
Forks
108
Avg merge
4d 13h
Merged PRs (30d)
3

Description

At the same time resolving https://github.com/solid/specification/issues/141 (Determine the URIs for the specifications) and https://github.com/solid/solidproject.org/issues/247 (Publish a URI Persistence Policy) , existing github.io spec URLs need some attention. Options:

  • Remove gh pages branch - 404/410s github.io
  • Redirect gh pages to new location - 3xx to solidproject.org/TR/
  • Other...?

For the time being, if possible, I find redirect most appealing as there are existing references to solid .github .io / specification /* . This is the same issue for documents published via gh pages by panels in their respective repositories.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review specification issue #141 and solidproject.org issue #247 first, then inventory the existing github.io specification URLs and the GitHub Pages publications from panels. Resolve the chosen URL policy and verify that existing references either redirect to solidproject.org/TR/ or intentionally return the documented replacement status.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.