From b138e873ba964a3e301fc7a95f1f043c362bd2a7 Mon Sep 17 00:00:00 2001 From: Julio Biason Date: Sun, 23 Jun 2019 09:50:31 -0300 Subject: [PATCH] Reorganized the index, with better sub-topics --- content/books/things-i-learnt/_index.md | 30 +++++++++++-------- .../document-is-contract/index.md | 2 +- .../things-i-learnt/document-it/index.md | 2 +- .../things-i-learnt/future-trashing/index.md | 2 +- .../things-i-learnt/languages-tests/index.md | 2 +- .../tests-in-the-command-line/index.md | 2 +- .../books/things-i-learnt/throw-away/index.md | 2 +- 7 files changed, 23 insertions(+), 19 deletions(-) diff --git a/content/books/things-i-learnt/_index.md b/content/books/things-i-learnt/_index.md index 0568ff0..71ccbc4 100644 --- a/content/books/things-i-learnt/_index.md +++ b/content/books/things-i-learnt/_index.md @@ -7,16 +7,20 @@ template = "section-contentless.html" * [Intro](intro) * [Disclaimer](disclaimer) -* Programming: - * [Spec First, Then Code](spec-first) - * [Write Steps as Comments](steps-as-comments) - * [Gherkin Is Your Friend to Understand Expectations](gherkin) - * [Unit Tests Are Good, Integration Tests Are Gooder](integration-tests) - * [Testing Every Function Creates Dead Code](tests-dead-code) - * [Tests Make Better APIs](tests-apis) - * [Make Tests That You Know How To Run on the Command line](tests-in-the-command-line) - * [Be Ready To Throw Your Code Away](throw-away) - * [Good Languages Come With Tests](languages-tests) - * [Future Thinking Is Future Trashing](future-trashing) - * [Documentation Is a Love Letter To Your Future Self](document-it) - * [The Function Documentation Is Its Contract](document-is-contract) +* Programming + * Before you start writing code... + * [Spec First, Then Code](spec-first) + * [Write Steps as Comments](steps-as-comments) + * [Gherkin Is Your Friend to Understand Expectations](gherkin) + * Testing Software + * [Unit Tests Are Good, Integration Tests Are Gooder](integration-tests) + * [Testing Every Function Creates Dead Code](tests-dead-code) + * [Tests Make Better APIs](tests-apis) + * [Make Tests That You Know How To Run On The Command Line](tests-in-the-command-line) + * [Good Languages Come With Tests](languages-tests) + * Documentating your code + * [Documentation Is A Love Letter To Your Future Self](document-it) + * [The Function Documentation Is Its Contract](document-is-contract) + * Writing code + * [Be Ready To Throw Your Code Away](throw-away) + * [Future Thinking Is Future Trashing](future-trashing) diff --git a/content/books/things-i-learnt/document-is-contract/index.md b/content/books/things-i-learnt/document-is-contract/index.md index 9c02812..078aed8 100644 --- a/content/books/things-i-learnt/document-is-contract/index.md +++ b/content/books/things-i-learnt/document-is-contract/index.md @@ -34,4 +34,4 @@ whatever you initially said your function would do -- so the correct solution would be to add a new function with a proper contract -- and probably a better name. -{{ chapters(prev_chapter_link="/books/things-i-learnt/document-it", prev_chapter_title="Documentation Is a Love Letter To Your Future Self") }} +{{ chapters(prev_chapter_link="/books/things-i-learnt/document-it", prev_chapter_title="Documentation Is a Love Letter To Your Future Self", next_chapter_link="/books/things-i-learnt/throw-away", next_chapter_title="Be Ready To Throw Your Code Away") }} diff --git a/content/books/things-i-learnt/document-it/index.md b/content/books/things-i-learnt/document-it/index.md index fe34aa0..4e5a972 100644 --- a/content/books/things-i-learnt/document-it/index.md +++ b/content/books/things-i-learnt/document-it/index.md @@ -25,4 +25,4 @@ I have some bad news for you... [^1]: Please, don't make me revise this in 2027... :( -{{ chapters(prev_chapter_link="/books/things-i-learnt/future-trashing", prev_chapter_title="Future Thinking is Future Trashing", next_chapter_link="/books/things-i-learnt/document-is-contract", next_chapter_title="The Function Documentation Is Its Contract") }} +{{ chapters(prev_chapter_link="/books/things-i-learnt/languages-tests", prev_chapter_title="Good Languages Come With Tests", next_chapter_link="/books/things-i-learnt/document-is-contract", next_chapter_title="The Function Documentation Is Its Contract") }} diff --git a/content/books/things-i-learnt/future-trashing/index.md b/content/books/things-i-learnt/future-trashing/index.md index 1b7874b..5b0fe8d 100644 --- a/content/books/things-i-learnt/future-trashing/index.md +++ b/content/books/things-i-learnt/future-trashing/index.md @@ -23,4 +23,4 @@ solutions and _then_ you'll find your "solve everything". This pattern is the _abstraction_ you're looking for and _then_ you'll be able to solve it in a simple way. -{{ chapters(prev_chapter_link="/books/things-i-learnt/languages-tests", prev_chapter_title="Good Languages Come With Tests", next_chapter_link="/books/things-i-learnt/document-id", next_chapter_title="Documentation Is a Love Letter To Your Future Self") }} +{{ chapters(prev_chapter_link="/books/things-i-learnt/throw-away", prev_chapter_title="Be Ready To Throw Your Code Away") }} diff --git a/content/books/things-i-learnt/languages-tests/index.md b/content/books/things-i-learnt/languages-tests/index.md index 2f0d7e1..d1074a5 100644 --- a/content/books/things-i-learnt/languages-tests/index.md +++ b/content/books/things-i-learnt/languages-tests/index.md @@ -22,4 +22,4 @@ testing framework in their standard library may have options with better support and easier access but, again, when they are there from the start, the start is better and the final result is better. -{{ chapters(prev_chapter_link="/books/things-i-learnt/throw-away", prev_chapter_title="Be Ready To Throw Your Code Away", next_chapter_link="/books/things-i-learnt/future-trashing", next_chapter_title="Future Thinking is Future Trashing") }} +{{ chapters(prev_chapter_link="/books/things-i-learnt/tests-in-the-command-line", prev_chapter_title="Make Tests That You Know How To Run On The Command Line", next_chapter_link="/books/things-i-learnt/document-it", next_chapter_title="Documentation Is A Love Letter To Your Future Self") }} diff --git a/content/books/things-i-learnt/tests-in-the-command-line/index.md b/content/books/things-i-learnt/tests-in-the-command-line/index.md index 964bbf0..2f29cec 100644 --- a/content/books/things-i-learnt/tests-in-the-command-line/index.md +++ b/content/books/things-i-learnt/tests-in-the-command-line/index.md @@ -34,4 +34,4 @@ you have no idea how those things "happen", you'll need the help of someone else to actually build this kind of stuff, instead of having the knowledge (well, half knowledge, the other half is the CI tool) with you all the time. -{{ chapters(prev_chapter_link="/books/things-i-learnt/tests-apis", prev_chapter_title="Tests Make Better APIs", next_chapter_link="/books/things-i-learnt/throw-away", next_chapter_title="Be Ready To Throw Your Code Away") }} +{{ chapters(prev_chapter_link="/books/things-i-learnt/tests-apis", prev_chapter_title="Tests Make Better APIs", next_chapter_link="/books/things-i-learnt/languages-tests", next_chapter_title="Good Languages Come With Tests") }} diff --git a/content/books/things-i-learnt/throw-away/index.md b/content/books/things-i-learnt/throw-away/index.md index 3f3a84b..34641ac 100644 --- a/content/books/things-i-learnt/throw-away/index.md +++ b/content/books/things-i-learnt/throw-away/index.md @@ -35,4 +35,4 @@ solves the problem, but also the tests for that code. ... unless you focus mostly on [integration tests](/books/things-i-learnt/integration-tests). -{{ chapters(prev_chapter_link="/books/things-i-learnt/tests-in-the-command-line", prev_chapter_title="Make Tests That You Know How To Run on the Command line", next_chapter_link="/books/things-i-learnt/language-tests", next_chapter_title="Good Languages Come With Tests") }} +{{ chapters(prev_chapter_link="/books/things-i-learnt/document-is-contract", prev_chapter_title="The Function Documentation Is Its Contract", next_chapter_link="/books/things-i-learnt/future-trashing", next_chapter_title="Future Thinking Is Future Trashing") }}