Documentation Links Broken

[marstonstudio]

Trying to use the documentation links here: http://www.restlet.org/documentation/2.1/

And many of them do failed redirects to the internet archive. For instance this link http://wiki.restlet.org/docs_2.1/13-restlet/21-restlet.html

redirects here http://web.archive.org/liveweb/http://web.archive.org/web/20120529060439/http://wiki.restlet.org/docs_2.1/13-restlet/21-restlet.html

which shows "Hrm. Wayback Machine doesn't have that page archived. It doesn't seem to be available on the live web, either."

[jlouvel]

We are in the process of migrating the content to GitHub and static pages on Restlet.org

Which page are you exactly looking at?

[marstonstudio]

I was looking at the links on the page http://www.restlet.org/documentation/2.1/

seems like they are working now, although strange to point to the internet archive . . . .

looking forward to seeing the content on github.

Restlet is great open source project that we rely on in our production apps, thanks for all the hard work!

[jlouvel]

The migration to GitHub and our new site is moving forward. For now, you can find the content at: https://github.com/restlet/restlet-sites/blob/master/modules/org.restlet/learn/guide/2.1/index.md

[ghost]

We are scheduling a review of documentation links so that we fix most obviously broken ones. Here are the first identified tasks :

• evaluate broken link types
• fix a first set of broken links
• evaluate next steps and associated workload

[jlouvel]

I have started to fix some of those links a few days ago (and updated the GitHub pointer in my previous comment).

Basically, the goal is to have:

• the navigation working in GitHub / Markdown (so links need to have the ".md" suffixes, and "index.md" for folders)
• the HTML generator needs to remove those suffixes and even the "index.md" file part so URIs of HTML pages are clean
• ensure that we consistently update/fix the links across all versions of the framework
• maybe decide that we remove the older versions of documentation (2.0, 1.1 and 1.0) to save us this tedious work for older unsupported versions.
  • if we do so, we should keep in the 2.1 user guide the migration information from 1.0 to 1.1, 1.1 to 2.0 and 2.0 to 2.1 in the 2.1 user guide so devs with older versions can upgrade their code easily.

[jlouvel]

• images also need to be restored / regenerated / recreated
• anchors can be added and used inside Markdown docs, see the first steps pages for example

[jlouvel]

As discussed with @thboileau here is the new plan:

• along with 2.1.7 and 2.2 RC1 releases, fix the links including a ".md" suffix when generating HTML
• along with 2.2.0 (stable) and 3.0 M1 (testing) releases, the "2.1" branch will be deprecated/archived
• take this opportunity to remove the Tutorial and User Guide for all versions except "2.2" \ only move the migration instructions from older version into the "2.2" user guide so users with older/unsupported versions can have a clear path for migration
• fix/clean/upgrade the 2.2 documentation (tutorial and user guide) before 2.2.0 release at the end of February

[thboileau]

reassigned to @jlouvel for testing purpose

[jlouvel]

Looks good in staging for 2.2.0 release. More work needed moving forward.

[jlouvel]

Assigned to @ssfartz

[ghost]

Closing for 2.0