search

ssbc / handbook.scuttlebutt.nz

ssb handbook: A guide to the Secure Scuttlebutt key concepts and influences (see also, new website: https://gitlab.com/ssbc/scuttlebutt.nz/)
https://handbook.scuttlebutt.nz
166 stars 48 forks source link

Create readme for ssb-handbook that isn't index page #120

Open christianbundy opened 5 years ago

christianbundy commented 5 years ago

This is mostly a todo for myself, but I'd love to add a readme for the ssb-handbook module that isn't just the main page of the website.

ahdinosaur commented 5 years ago

@christianbundy https://toolchain.gitbook.com/config.html#structure

christianbundy commented 5 years ago

@ahdinosaur Thanks! Do you think that we should mess with those settings to have a separate readme, or should I include information about ssb-handbook in the readme itself? I'm not sure what the goal of the gitbook is so I'm hesitant to make it self-referential unless that's the vibe we're going for.

ahdinosaur commented 5 years ago

@christianbundy i'm not sure what the best way is. but to start, we could make the link to contributing.md more prominent in README.md, where contributing.md should try to describe what the GitBook is about and how to contribute. i'm also happy if we changed the current README.md to something like index.md as the main landing page for the deployed GitBook, then made a separate README.md which is the landing page for when viewing the code.

marylychee commented 5 years ago

Hey @ahdinosaur this is my Doco Drive for this week, but I can't read the linked stuff as it seems to be in legacy.gitbook.com now?? and I'm not a member of this gitbook so how do I help/do things?

@christianbundy - I think part of the confusion, is that ssb-handbook is kind of the first front facing 'landing page' and for newbies there's so much information. I think Mikey's suggestion is pretty good!

ahdinosaur commented 5 years ago

@marylychee https://scuttlebutt.nz is built from this GitHub repo anytime something is published to master, we use gitbook as a way to write markdown and build html, but we use http://netlify.com/ to run npm run build and host the html content inside _book, so if you want to change anything on the website then a change to this GitHub repo will do the trick. hope that helps. :heart:

ahdinosaur commented 5 years ago

seems GitBook version 2 no longer has a gitbook cli tool to generate html, so we can't upgrade unless we buy into their platform (and pay their fees). so we're stuck with GitBook version 1 or we can migrate to mdBook which is a Rust implementation of the same functionality, but that's separate from this issue (where we could do the same by disabling their index preprocessor (see mdBook config)).