Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Related content" section at the bottom of each page. #250

Closed
daviddias opened this issue Sep 29, 2018 · 5 comments
Closed

Add "Related content" section at the bottom of each page. #250

daviddias opened this issue Sep 29, 2018 · 5 comments
Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week kind/enhancement A net-new feature or an improvement to an existing feature P3 Low: Not priority right now status/inactive No significant work in the previous month topic/design-front-end Front-end implementation of UX/UI work

Comments

@daviddias
Copy link
Member

Use VuePress front matter, combined with a similar component methodology to what was used for "no content yet" stub pages, to generate a "related content" section of each page, highlighting in particular community-generated materials.

Please note that this may be a proof of concept for general tagging/taxonomy work in the site in the future, so designing this particularly future-proof is a good endeavor.

Original notes follow for context:

Our friends at Textile created a full Training Program to teach devs on how to build for the Decentralized Web.

https://medium.com/textileio/announcing-textile-build-a-free-online-workshop-27472fd5d913
image

The recording from these sessions live at https://www.youtube.com/watch?v=gOzAYiT1Z4U&list=PLC8CEtJ9shDznO1tpvGe--BVEWmCKY9_Z

image

The series cover a ton of content and touch multiple parts of the stack + guide devs through building a full DApps. This is really great 👏🏽👏🏽👏🏽👏🏽👏🏽👏🏽

lidel referenced this issue in lidel/awesome-ipfs Oct 15, 2018
@lidel
Copy link
Member

lidel commented Oct 15, 2018

Not sure where it fits. Should we add "Training and Courses" subsection to the "Community" one at http://docs.ipfs.io ?

For now I've proposed adding it to http://awesome.ipfs.io (ipfs/awesome-ipfs#205)

@jessicaschilling
Copy link
Contributor

Putting this one into our "OKR: Hotfixes" bucket, since it's a link to a helpful resource that can benefit folks in the short-term while we align ourselves on revamping the docs platform as a whole. Two things to note though:

  1. The link to use is as follows: https://www.youtube.com/playlist?list=PLC8CEtJ9shDznO1tpvGe--BVEWmCKY9_Z
  2. There's still no great place in the existing docs site to link this out to. @lidel's suggestion above of adding a subsection "Tutorials & Courses" to the "Community" section seems best to me, though. (If we do that, note it'll be a loner on that page unless someone would be kind enough to add a few more known-awesome community tutorials! agentofuser's Interplanetary Gatsby one - http://interplanetarygatsby.com/ipfs-deploy/ - is one nomination.)

@jessicaschilling jessicaschilling changed the title How to Build for the Distributed Web - Textile Training Series Create place to link to community tutorials, starting with this one from Textile Jul 26, 2019
@jessicaschilling jessicaschilling changed the title Create place to link to community tutorials, starting with this one from Textile Hotfix: Create place to link to community tutorials, starting with this one from Textile Aug 26, 2019
@jessicaschilling jessicaschilling changed the title Hotfix: Create place to link to community tutorials, starting with this one from Textile Create place to link to community tutorials, starting with this one from Textile Sep 19, 2019
@jessicaschilling
Copy link
Contributor

Update: We're discussing best approaches to community-generated content as part of a general taxonomy discussion. Ref ipfs-inactive/docs#347.

@jessicaschilling jessicaschilling changed the title Create place to link to community tutorials, starting with this one from Textile Create "related content" section with space for community materials Dec 12, 2019
@jessicaschilling
Copy link
Contributor

Adding this screenshot from @ericronne illustrating visual layout of a "related content" section on the new docs site; this can be used to include project-generated or community-generated links. We can use the same front-matter methodology as the content stub pages' "try these links in the meantime" links to build this.

ipfs-docs-style-tile-A

@hsanjuan hsanjuan transferred this issue from ipfs-inactive/docs May 22, 2020
@johnnymatthews johnnymatthews changed the title Create "related content" section with space for community materials Add "Related content" section at the bottom of each page. Jun 18, 2020
@johnnymatthews johnnymatthews added dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week kind/enhancement A net-new feature or an improvement to an existing feature P3 Low: Not priority right now status/inactive No significant work in the previous month topic/design-front-end Front-end implementation of UX/UI work labels Jun 18, 2020
@johnnymatthews
Copy link
Contributor

Pretty much anytime there's further content that can be explored, it's just linked to using a hyperlink. While styling related content is a nice-to-have feature, it's not necessary, and likely won't be tackled anytime soon. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week kind/enhancement A net-new feature or an improvement to an existing feature P3 Low: Not priority right now status/inactive No significant work in the previous month topic/design-front-end Front-end implementation of UX/UI work
Projects
None yet
Development

No branches or pull requests

4 participants