Patrick Georgi has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "code labs" ......................................................................
Documentation: rename "Rookie guide" to "code labs"
We generally try to stay away from ascribing attributes to (future) devs. "Rookie guide" refers to the reader, while "code labs" refers to the material.
In the same spirit, move from "lessons" to "parts". It's not school :-)
Change-Id: I11a69a2a05ba9a0bc48f8bf62463d9585da043ec Signed-off-by: Patrick Georgi pgeorgi@google.com --- A Documentation/codelabs/index.md R Documentation/codelabs/part1.md R Documentation/codelabs/part2.md M Documentation/index.md D Documentation/lessons/index.md M Documentation/mainboard/supermicro/x10slm-f.md 6 files changed, 9 insertions(+), 9 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/25/35425/1
diff --git a/Documentation/codelabs/index.md b/Documentation/codelabs/index.md new file mode 100644 index 0000000..66b9be7 --- /dev/null +++ b/Documentation/codelabs/index.md @@ -0,0 +1,4 @@ +# Code labs + +* [Part 1: Starting from scratch](part1.md) +* [Part 2: Submitting a patch to coreboot.org](part2.md) diff --git a/Documentation/lessons/lesson1.md b/Documentation/codelabs/part1.md similarity index 98% rename from Documentation/lessons/lesson1.md rename to Documentation/codelabs/part1.md index bbb3eb5..2ebb955 100644 --- a/Documentation/lessons/lesson1.md +++ b/Documentation/codelabs/part1.md @@ -1,5 +1,5 @@ -coreboot Lesson 1: Starting from scratch -======================================== +coreboot code lab #1: Starting from scratch +===========================================
From a fresh Ubuntu 16.04 or 18.04 install, here are all the steps required for a very basic build: diff --git a/Documentation/lessons/lesson2.md b/Documentation/codelabs/part2.md similarity index 98% rename from Documentation/lessons/lesson2.md rename to Documentation/codelabs/part2.md index ae70c70..55222a9 100644 --- a/Documentation/lessons/lesson2.md +++ b/Documentation/codelabs/part2.md @@ -1,4 +1,4 @@ -# coreboot Lesson 2: Submitting a patch to coreboot.org +# coreboot code lab #2: Submitting a patch to coreboot.org
## Part 1: Setting up an account at coreboot.org
diff --git a/Documentation/index.md b/Documentation/index.md index 50141b5..43194ce 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -161,7 +161,7 @@ Contents:
* [Getting Started](getting_started/index.md) -* [Rookie Guide](lessons/index.md) +* [Code labs](codelabs/index.md) * [Coding Style](coding_style.md) * [Project Ideas](contributing/project_ideas.md) * [Code of Conduct](community/code_of_conduct.md) diff --git a/Documentation/lessons/index.md b/Documentation/lessons/index.md deleted file mode 100644 index 6540e8c..0000000 --- a/Documentation/lessons/index.md +++ /dev/null @@ -1,4 +0,0 @@ -# Rookie Guide - -* [Lesson 1: Starting from scratch](lesson1.md) -* [Lesson 2: Submitting a patch to coreboot.org](lesson2.md) diff --git a/Documentation/mainboard/supermicro/x10slm-f.md b/Documentation/mainboard/supermicro/x10slm-f.md index 2c2e6a8..8832e45 100644 --- a/Documentation/mainboard/supermicro/x10slm-f.md +++ b/Documentation/mainboard/supermicro/x10slm-f.md @@ -12,7 +12,7 @@
```eval_rst If you haven't already, build the coreboot toolchain as described in -:doc:`../../lessons/lesson1`. +:doc:`../../codelabs/part1`. ```
A fully working image should be possible so long as you have the
Angel Pons has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "code labs" ......................................................................
Patch Set 1: Code-Review+1
Arthur Heymans has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "code labs" ......................................................................
Patch Set 1: Code-Review+2
Jacob Garber has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "code labs" ......................................................................
Patch Set 1:
As a former beginner, I agree we should change away from "Rookie guide", but I don't think it is immediately clear that "Code labs" would be the place someone should go if they don't know anything about the project. Maybe something like "Getting started" or "Tutorials" would be better?
Plus, if the desire is to not feel like school, then "Code labs" makes me feel even more like school, not less :)
Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "code labs" ......................................................................
Patch Set 1:
Patch Set 1:
As a former beginner, I agree we should change away from "Rookie guide", but I don't think it is immediately clear that "Code labs" would be the place someone should go if they don't know anything about the project. Maybe something like "Getting started" or "Tutorials" would be better?
Plus, if the desire is to not feel like school, then "Code labs" makes me feel even more like school, not less :)
Must be the Google influence, I took the term from https://codelabs.developers.google.com/
Maybe tutorial really is best, will change.
Felix Held has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "code labs" ......................................................................
Patch Set 1:
yep, tutorial or development tutorial would be clearer
Hello Angel Pons, Arthur Heymans, build bot (Jenkins),
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/35425
to look at the new patch set (#2).
Change subject: Documentation: rename "Rookie guide" to "code labs" ......................................................................
Documentation: rename "Rookie guide" to "code labs"
We generally try to stay away from ascribing attributes to (future) devs. "Rookie guide" refers to the reader, while "code labs" refers to the material.
In the same spirit, move from "lessons" to "parts". It's not school :-)
Change-Id: I11a69a2a05ba9a0bc48f8bf62463d9585da043ec Signed-off-by: Patrick Georgi pgeorgi@google.com --- M Documentation/index.md D Documentation/lessons/index.md M Documentation/mainboard/supermicro/x10slm-f.md A Documentation/tutorial/index.md R Documentation/tutorial/part1.md R Documentation/tutorial/part2.md 6 files changed, 9 insertions(+), 9 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/25/35425/2
Hello Angel Pons, Arthur Heymans, build bot (Jenkins),
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/35425
to look at the new patch set (#3).
Change subject: Documentation: rename "Rookie guide" to "tutorial" ......................................................................
Documentation: rename "Rookie guide" to "tutorial"
We generally try to stay away from ascribing attributes to (future) devs. "Rookie guide" refers to the reader, while "tutorial" refers to the material.
In the same spirit, move from "lessons" to "parts". It's not school :-)
Change-Id: I11a69a2a05ba9a0bc48f8bf62463d9585da043ec Signed-off-by: Patrick Georgi pgeorgi@google.com --- M Documentation/index.md D Documentation/lessons/index.md M Documentation/mainboard/supermicro/x10slm-f.md A Documentation/tutorial/index.md R Documentation/tutorial/part1.md R Documentation/tutorial/part2.md 6 files changed, 9 insertions(+), 9 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/25/35425/3
Lance Zhao has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "tutorial" ......................................................................
Patch Set 3: Code-Review+2
Jacob Garber has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "tutorial" ......................................................................
Patch Set 3: Code-Review+1
Angel Pons has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "tutorial" ......................................................................
Patch Set 3: Code-Review+2
Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/coreboot/+/35425 )
Change subject: Documentation: rename "Rookie guide" to "tutorial" ......................................................................
Documentation: rename "Rookie guide" to "tutorial"
We generally try to stay away from ascribing attributes to (future) devs. "Rookie guide" refers to the reader, while "tutorial" refers to the material.
In the same spirit, move from "lessons" to "parts". It's not school :-)
Change-Id: I11a69a2a05ba9a0bc48f8bf62463d9585da043ec Signed-off-by: Patrick Georgi pgeorgi@google.com Reviewed-on: https://review.coreboot.org/c/coreboot/+/35425 Tested-by: build bot (Jenkins) no-reply@coreboot.org Reviewed-by: Lance Zhao lance.zhao@gmail.com Reviewed-by: Jacob Garber jgarber1@ualberta.ca Reviewed-by: Angel Pons th3fanbus@gmail.com --- M Documentation/index.md D Documentation/lessons/index.md M Documentation/mainboard/supermicro/x10slm-f.md A Documentation/tutorial/index.md R Documentation/tutorial/part1.md R Documentation/tutorial/part2.md 6 files changed, 9 insertions(+), 9 deletions(-)
Approvals: build bot (Jenkins): Verified Lance Zhao: Looks good to me, approved Angel Pons: Looks good to me, approved Jacob Garber: Looks good to me, but someone else must approve
diff --git a/Documentation/index.md b/Documentation/index.md index 50141b5..b880c1c 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -161,7 +161,7 @@ Contents:
* [Getting Started](getting_started/index.md) -* [Rookie Guide](lessons/index.md) +* [Tutorial](tutorial/index.md) * [Coding Style](coding_style.md) * [Project Ideas](contributing/project_ideas.md) * [Code of Conduct](community/code_of_conduct.md) diff --git a/Documentation/lessons/index.md b/Documentation/lessons/index.md deleted file mode 100644 index 6540e8c..0000000 --- a/Documentation/lessons/index.md +++ /dev/null @@ -1,4 +0,0 @@ -# Rookie Guide - -* [Lesson 1: Starting from scratch](lesson1.md) -* [Lesson 2: Submitting a patch to coreboot.org](lesson2.md) diff --git a/Documentation/mainboard/supermicro/x10slm-f.md b/Documentation/mainboard/supermicro/x10slm-f.md index 2c2e6a8..8a91c89 100644 --- a/Documentation/mainboard/supermicro/x10slm-f.md +++ b/Documentation/mainboard/supermicro/x10slm-f.md @@ -12,7 +12,7 @@
```eval_rst If you haven't already, build the coreboot toolchain as described in -:doc:`../../lessons/lesson1`. +:doc:`../../tutorial/part1`. ```
A fully working image should be possible so long as you have the diff --git a/Documentation/tutorial/index.md b/Documentation/tutorial/index.md new file mode 100644 index 0000000..48dfbe5 --- /dev/null +++ b/Documentation/tutorial/index.md @@ -0,0 +1,4 @@ +# Tutorial + +* [Part 1: Starting from scratch](part1.md) +* [Part 2: Submitting a patch to coreboot.org](part2.md) diff --git a/Documentation/lessons/lesson1.md b/Documentation/tutorial/part1.md similarity index 98% rename from Documentation/lessons/lesson1.md rename to Documentation/tutorial/part1.md index bbb3eb5..75a9ba3 100644 --- a/Documentation/lessons/lesson1.md +++ b/Documentation/tutorial/part1.md @@ -1,5 +1,5 @@ -coreboot Lesson 1: Starting from scratch -======================================== +Tutorial, part 1: Starting from scratch +===========================================
From a fresh Ubuntu 16.04 or 18.04 install, here are all the steps required for a very basic build: diff --git a/Documentation/lessons/lesson2.md b/Documentation/tutorial/part2.md similarity index 98% rename from Documentation/lessons/lesson2.md rename to Documentation/tutorial/part2.md index ae70c70..e532218 100644 --- a/Documentation/lessons/lesson2.md +++ b/Documentation/tutorial/part2.md @@ -1,4 +1,4 @@ -# coreboot Lesson 2: Submitting a patch to coreboot.org +# Tutorial, part 2: Submitting a patch to coreboot.org
## Part 1: Setting up an account at coreboot.org
-
Angel Pons (Code Review) -
Arthur Heymans (Code Review)
-
Felix Held (Code Review)
-
Jacob Garber (Code Review)
-
Lance Zhao (Code Review)
-
Patrick Georgi (Code Review)