This repository was archived by the owner on Jun 2, 2020. It is now read-only.
Move examples from old docs site to this repo#115
Merged
Conversation
Instead of linking to the old docs site like we used to, expose the same examples here. These are still really out of date and need auditing (see #76), but this at least allows us to keep the content maintained here instead of linking to a site we are deprecating. Note: this does away with the old example viewer and the example JS apps! I think this is OK: the viewer was another thing to maintain and that nobody was working on; the example JS apps didn't do anything that was special to IPFS or to the distributed web, so they weren't especially relevant here. License: MIT Signed-off-by: Rob Brackett <rob@robbrackett.com>
License: MIT Signed-off-by: Rob Brackett <rob@robbrackett.com>
This was referenced Aug 24, 2018
Collaborator
Author
|
I’m going to go ahead and merge this since it’s been sitting with no feedback for a while, but is needed to clearly and finally separate the content here from |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We actually already had a copy of all the old docs site’s examples here, but they were not exposed in the built site and we linked to the examples from the old site instead. This was because there wasn’t a clear direction for how to handle the “example viewer” app that was used to render them.
Now we need to make a clean break from the old site, so we’re exposing the copies we have here and linking to them instead. That means:
I’ve also added @lidel’s fixes from ipfs-inactive/website#259.
We can also add new examples to the
content/guides/examplesdirectory and they’ll get listed now! There are two special notes about that:Unlike most listing pages, we don’t use Hugo’s
.Summaryvariable for summaries on the examples listing page. (It would have been a big change to adapt all the examples to have a nice intro paragraph.) Instead, we use adescriptionvariable from the front-matter of each example.I’ve removed these from the sidebar menus. They never showed up there before because they were drafts, but if we want new content to be listed, use the following in the front-matter of the new content:
Finally, this does not complete #76. These examples are just as out-of-date as they ever were, and still need to be audited for cleanup or removal. This is mainly about removing the last dependency on the old docs site at https://ipfs.io/docs.