Missing TOC or Jump-Offs from README.md

[hlgr360]

What I am missing is a TOC or a set of jumping off links in the README ... right now if I look at the repo, the README is standalone and does not guide me towards the initial chapters.

Look at https://github.com/Haufe-Lexware/api-style-guide for an example.

[SSpeights]

Ugh,

Can't we just turn it into a gitbook? I created a book here https://www.gitbook.com/book/haufe-lexware/haufe-group-docker-book-startup-guide/welcome

in the Haufe-Lexware Dev domain but I don't have enough juice couple it to the "Docker Style Guide". To do this, you go into

Settings > GitHub

In the GitHub Repo section you should be able to hook up the style guide repo as the source for this book. Otherwise the links are in SUMMARY.md?.

Scott

---

From: Holger Reinhardt notifications@github.com Sent: Wednesday, January 4, 2017 11:25 PM To: Haufe-Lexware/docker-style-guide Cc: Subscribed Subject: [Haufe-Lexware/docker-style-guide] Missing TOC or Jump-Offs from README.md (#15)

What I am missing is a TOC or a set of jumping off links in the README ... right now if I look at the repo, the README is standalone and does not guide me towards the initial chapters.

Look at https://github.com/Haufe-Lexware/api-style-guide for an example.

- You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/Haufe-Lexware/docker-style-guide/issues/15, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AFrBo37Y_15yUrBbL12Y9x_IdUTX__HFks5rPBxrgaJpZM4LbIsN.

[hlgr360]

We should do both .. look at https://github.com/zalando/restful-api-guidelines for example .. they have the Gitbook at http://zalando.github.io/restful-api-guidelines/ but since some folks come in through the plain repo view they provide a "basic" getting started outline also in the readme.md

[hlgr360]

Clicking on the URL you provided I get a login page to gitbook

[SSpeights]

?Ok. Got it. I will add the links today. The first feedback for the book was both good and helpful, so I will include the links with these changes.

Scott

---

From: Holger Reinhardt notifications@github.com Sent: Thursday, January 5, 2017 3:08 PM To: Haufe-Lexware/docker-style-guide Cc: Speights, Scott; Assign Subject: Re: [Haufe-Lexware/docker-style-guide] Missing TOC or Jump-Offs from README.md (#15)

We should do both .. look at https://github.com/zalando/restful-api-guidelines for example .. they have the Gitbook at http://zalando.github.io/restful-api-guidelines/ but since some folks come in through the plain repo view they provide a "basic" getting started outline also in the readme.md

- You are receiving this because you were assigned. Reply to this email directly, view it on GitHubhttps://github.com/Haufe-Lexware/docker-style-guide/issues/15#issuecomment-270651643, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AFrBoy4R-zMSMnS6TJ1__3Gb232bA-IEks5rPPlKgaJpZM4LbIsN.

[SSpeights]

Hi Holger,

OK. I will turn it into “book format”. I need to change the format anyway to something a little more booky and less FAQ-y. So, I have pointed our test candidates at the book on my repo https://sspeights.gitbooks.io/haufe-group-docker-book/content

VG, Scott

From: Holger Reinhardt [mailto:notifications@github.com] Sent: Wednesday, January 4, 2017 11:26 PM To: Haufe-Lexware/docker-style-guide docker-style-guide@noreply.github.com Cc: Subscribed subscribed@noreply.github.com Subject: [Haufe-Lexware/docker-style-guide] Missing TOC or Jump-Offs from README.md (#15)

What I am missing is a TOC or a set of jumping off links in the README ... right now if I look at the repo, the README is standalone and does not guide me towards the initial chapters.

Look at https://github.com/Haufe-Lexware/api-style-guide for an example.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://github.com/Haufe-Lexware/docker-style-guide/issues/15, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AFrBo37Y_15yUrBbL12Y9x_IdUTX__HFks5rPBxrgaJpZM4LbIsN.

[hlgr360]

merged pull #16 . very nice