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.

Sign up for GitHub

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

Jump to bottom

10c docs reorganize general and jsl #851

Merged
merged 1 commit into from
Sep 16, 2024
Merged

10c docs reorganize general and jsl #851

merged 1 commit into from
Sep 16, 2024

Conversation

philipandag
Copy link
Contributor

No description provided.

mkopec
mkopec reviewed Jul 3, 2024
View reviewed changes
mkdocs.yml Outdated Show resolved Hide resolved
mkopec
mkopec reviewed Jul 3, 2024
View reviewed changes
mkdocs.yml Outdated Show resolved Hide resolved
@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from 18c744c to c60da47 Compare July 4, 2024 10:20
@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch 2 times, most recently from 8f67e2b to f06816f Compare July 19, 2024 06:21
@philipandag philipandag changed the base branch from master to add-protectli-v1211 July 23, 2024 05:10
@philipandag philipandag changed the base branch from add-protectli-v1211 to protectli_v121x_v0.9.2 July 23, 2024 05:11
@philipandag philipandag changed the base branch from protectli_v121x_v0.9.2 to master July 25, 2024 04:28
@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from b79ef4f to 365956c Compare July 25, 2024 04:35
@philipandag
Copy link
Contributor Author

pre-commit.ci crashes during the check, what do I do?

@mkopec
Copy link
Member

mkopec commented Aug 2, 2024

@philipandag some conflicts related to whitespace in mkdocs.yml

@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from cd55238 to 4bd0518 Compare August 5, 2024 09:03
@philipandag
Copy link
Contributor Author

@mkopec conflicts resolved

@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from feb5020 to 075a8db Compare August 9, 2024 08:55
@philipandag philipandag requested a review from mkopec August 9, 2024 08:55
@philipandag
Copy link
Contributor Author

philipandag commented Aug 9, 2024 •
edited
Loading

I think I have tamed an autolinter which was causing these merge conflicts. I will now proceed to squash the commits.

@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch 5 times, most recently from 730ce56 to 8237cbb Compare August 9, 2024 13:41
@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from e4ff0e7 to acf9477 Compare September 16, 2024 11:51
@miczyg1
Copy link
Contributor

miczyg1 commented Sep 16, 2024

@philipandag even more conflicts now :)

@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from acf9477 to 1aa230a Compare September 16, 2024 12:08
@philipandag
Copy link
Contributor Author

@philipandag even more conflicts now :)

I hate this branch. I would not learn so much about rebasing without this task though.
There are no conflicts now.

@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from 1aa230a to 1c4dae6 Compare September 16, 2024 12:15
@philipandag
Copy link
Contributor Author

@miczyg1 What to do with these orphaned pages?

  • /guides/lab-assembly/odroid-assembly-guide/
  • /variants/versions/
  • /dasharo-naming-convention/

@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch 2 times, most recently from bf700cf to 61dc0a2 Compare September 16, 2024 12:48
@philipandag
Copy link
Contributor Author

What to do with these orphaned pages?
They might have been removed durint some rebase. I'll check that first.

@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch 2 times, most recently from 2fe7f12 to a02c7e4 Compare September 16, 2024 13:01
@philipandag
Copy link
Contributor Author

@miczyg1 All CI checks now pass. Only the Ubuntu mirror at TASK is broken. It links to (...)/ubuntu-22.04.4(...) but there is only (...)/ubuntu-22.04.5(...) available there. Should I change it?

@miczyg1
Copy link
Contributor

miczyg1 commented Sep 16, 2024

@miczyg1 All CI checks now pass. Only the Ubuntu mirror at TASK is broken. It links to (...)/ubuntu-22.04.4(...) but there is only (...)/ubuntu-22.04.5(...) available there. Should I change it?

I think we have to bump to to 22.04.5 unfortunately...

@miczyg1
Copy link
Contributor

miczyg1 commented Sep 16, 2024

Also we cannot leave the commit message like this:

Signed-off-by: Filip Gołaś <[email protected]>

protectli/overview.md: Reformat

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Change unify protectly structure

Signed-off-by: Filip Gołaś <[email protected]>

/docs/variants/protectli*: Remove DTS support

Signed-off-by: Filip Gołaś <[email protected]>

docs/variants/protectli_v1x10: change to v1x1x

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview.md: Add v1x1x

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview.md: Reformat

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: change v1x10 to v1x1x

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview.md: Reformat

Signed-off-by: Filip Gołaś <[email protected]>

protectli_vp66xx/initial_deployment.md: typo

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Fix typo

Signed-off-by: Filip Gołaś <[email protected]>

protectli/overview.md: Comment was breaking the render

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview.md: Reformat

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Fix typo: v1x11 to v1x1x

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Comment out unused sections

Signed-off-by: Filip Gołaś <[email protected]>

protectli/overview.md: Fix typo V1x11 o V1x1x

Signed-off-by: Filip Gołaś <[email protected]>

protectli_v1x1x/hardware_matrix.md: Add v1211

Yanked off of miczyg1's commit:
https://github.com/Dasharo/docs/commit/026d93715e9e6f822b53e6929d6a2b134e2573ef

Signed-off-by: Filip Gołaś <[email protected]>

protectli/building-manual.md: Join building manuals

Signed-off-by: Filip Gołaś <[email protected]>

protectli/initial_deployment.md: Join initial deployments

Signed-off-by: Filip Gołaś <[email protected]>

protectli/initial-deployment.md: Unify more

Signed-off-by: Filip Gołaś <[email protected]>

protectli/firmware-update.md: Create unified file

Signed-off-by: Filip Gołaś <[email protected]>

protectli/firmware-update.md: Fix indentation length

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Enable unified Firmware Update section

Signed-off-by: Filip Gołaś <[email protected]>

protectli/building_manual.md: Fix whitespace

Signed-off-by: Filip Gołaś <[email protected]>

protectli/test_matrix.md: Create unified test matrix

Signed-off-by: Filip Gołaś <[email protected]>

protectli/recovery.md: Add unified recovery file

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/recovery.md: Join intro

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/test-matrix.md: Remove obsolete comments

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Remove ducplicate test-matrix in v1000 series

it was moved to unified/test-matrix

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_v1000-series: remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_vp2410: Remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_vp2420: Remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_vp66xx: Remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_vp46xx: Remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

test-matrix.md: Fix leftover conflict

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Add protectli firmware_update redirects

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Add protectli recovery redirects

Signed-off-by: Filip Gołaś <[email protected]>

protectli/initial-deployment.md: Add fw6

FW6 had a file called `installation-manual.md` and it is actually
the same as `initial-deployment.md` in other platforms but named
differently.

Signed-off-by: Filip Gołaś <[email protected]>

protectli/initial-deployment.md: Fix whitespace

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Move sections arond according to feedback

Signed-off-by: Filip Gołaś <[email protected]>

buiilding-manual.md: remove duplicated intro & requirements

Signed-off-by: Filip Gołaś <[email protected]>

unified/building-manual.md: Unify clone step

Signed-off-by: Filip Gołaś <[email protected]>

unified/../building-manual.md: typo: protectli -> Protectli

Signed-off-by: Filip Gołaś <[email protected]>

docs: Add protectli v1211 according to JanPrusinowski's https://github.com/Dasharo/docs/commit/c0b2c1c265c5a5544f8c463f275866ae2dffa2b5

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Remove commented out section

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/building-manual: Fix missing ```

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/building-manual.md: improve cloning part

Signed-off-by: Filip Gołaś <[email protected]>

docs: Break long urls to fit in 80c line width limit

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview: Rename v1x1x-> v1000 series, use `-` instead of `*`

pre-commit doesnt like `*` lists and treats the asterisk as an emphasis
like in `*italics*` and says you can not put a spacebar after the
asterisk. Sadly it breaks the lists rendering but using `-` doesnt
trigger the linter and looks the same after being rendered.

Signed-off-by: Filip Gołaś <[email protected]>

docs: Further rename V1210 etc to V1000 series

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: prettier v1000 series section name

Signed-off-by: Filip Gołaś <[email protected]>

docs/unified/protectli/firmware-update.md: Duplicate SecureBoot info

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/initial-deployment.md: Remove duplicate in FW6

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/firmware-update.md: Restore DTS info

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_v1x10 moved to protectli_v1000-series

Signed-off-by: Filip Gołaś <[email protected]>

laboratory-assembly-guide.md: Fix committed conflict

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Fix strings to use apostrophes

Signed-off-by: Filip Gołaś <[email protected]>

docs/unified/protectli: Add unified overview.md

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Change unify protectly structure

Signed-off-by: Filip Gołaś <[email protected]>

/docs/variants/protectli*: Remove DTS support

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview.md: Add v1x1x

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview.md: Reformat

Signed-off-by: Filip Gołaś <[email protected]>

protectli_vp66xx/initial_deployment.md: typo

Signed-off-by: Filip Gołaś <[email protected]>

protectli/overview.md: Comment was breaking the render

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview.md: Reformat

Signed-off-by: Filip Gołaś <[email protected]>

protectli/building-manual.md: Join building manuals

Signed-off-by: Filip Gołaś <[email protected]>

protectli/initial_deployment.md: Join initial deployments

Signed-off-by: Filip Gołaś <[email protected]>

protectli/initial-deployment.md: Unify more

Signed-off-by: Filip Gołaś <[email protected]>

protectli/building_manual.md: Fix whitespace

Signed-off-by: Filip Gołaś <[email protected]>

protectli/test_matrix.md: Create unified test matrix

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Add protectli recovery redirects

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Move sections arond according to feedback

Signed-off-by: Filip Gołaś <[email protected]>

buiilding-manual.md: remove duplicated intro & requirements

Signed-off-by: Filip Gołaś <[email protected]>

unified/building-manual.md: Unify clone step

Signed-off-by: Filip Gołaś <[email protected]>

unified/../building-manual.md: typo: protectli -> Protectli

Signed-off-by: Filip Gołaś <[email protected]>

docs: Add protectli v1211 according to JanPrusinowski's https://github.com/Dasharo/docs/commit/c0b2c1c265c5a5544f8c463f275866ae2dffa2b5

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/building-manual.md: improve cloning part

Signed-off-by: Filip Gołaś <[email protected]>

docs: Break long urls to fit in 80c line width limit

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/overview: Rename v1x1x-> v1000 series, use `-` instead of `*`

pre-commit doesnt like `*` lists and treats the asterisk as an emphasis
like in `*italics*` and says you can not put a spacebar after the
asterisk. Sadly it breaks the lists rendering but using `-` doesnt
trigger the linter and looks the same after being rendered.

Signed-off-by: Filip Gołaś <[email protected]>

unified/protectli/test-matrix.md: Remove obsolete comments

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_v1000-series: remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_vp2410: Remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_vp2420: Remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_vp66xx: Remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_vp46xx: Remove whats moved to unified

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli_v1x10 moved to protectli_v1000-series

Signed-off-by: Filip Gołaś <[email protected]>

laboratory-assembly-guide.md: Fix committed conflict

Signed-off-by: Filip Gołaś <[email protected]>

building-manual.md, overview.md, mkdocs: fixes

Signed-off-by: Filip Gołaś <[email protected]>

mkdocs.yml: Fix rebase errors

Signed-off-by: Filip Gołaś <[email protected]>

Protectli docs, mkdocs: Fix broken links, orphan pages

Signed-off-by: Filip Gołaś <[email protected]>

variants/protectli*: Delete unified pages, fix broken link

Signed-off-by: Filip Gołaś <[email protected]>

docs/variants/protectli_v1x10/hardware-matrix.md: v1410 update

Signed-off-by: Filip Lewiński <[email protected]>

docs protectli: Fix all links to unified documents

Signed-off-by: Filip Gołaś <[email protected]>

Just leave one sign-off per autor

@miczyg1
Copy link
Contributor

miczyg1 commented Sep 16, 2024

And what is this branch? https://github.com/Dasharo/docs/tree/10C-docs-Reorganize-general-and-jsl

@philipandag
Copy link
Contributor Author

Just leave one sign-off per autor

Ok, so the messages should be changed after squashing? Should I keep the commit messages, or remove them too along with the sign-offs?

@philipandag
Copy link
Contributor Author

And what is this branch? https://github.com/Dasharo/docs/tree/10C-docs-Reorganize-general-and-jsl

Typo in a push. I have deleted it.

@mkopec
Copy link
Member

mkopec commented Sep 16, 2024 •
edited
Loading

Ok, so the messages should be changed after squashing? Should I keep the commit messages, or remove them too along with the sign-offs?

I usually just use the first commit's message for the entire squashed commit. If there are multiple authors, keep the Signed-off-by and add Co-authored-by for each co-author, too.

@miczyg1
Copy link
Contributor

miczyg1 commented Sep 16, 2024

Just leave one sign-off per autor

Ok, so the messages should be changed after squashing? Should I keep the commit messages, or remove them too along with the sign-offs?

docs/unified/protectli: Reorganize protectli docs this commit message is ok, all you need is the signed-off-by or co-authered-by under it, that's all

@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from a02c7e4 to cd8f36a Compare September 16, 2024 13:45
@philipandag
Copy link
Contributor Author

philipandag commented Sep 16, 2024 •
edited
Loading

Updated the commit message. 514e8d2

@philipandag @JanPrusinowski
@miczyg1 @filipleple
docs/unified/protectli: Reorganize protectli docs
514e8d2 
Co-authored-by: Jan Prusinowski <[email protected]>
Co-authored-by: Michał Żygowski <[email protected]>
Co-authored-by: Filip Lewiński <[email protected]>
Signed-off-by: Filip Gołaś <[email protected]>
@philipandag philipandag force-pushed the 10C-Docs-Reorganize-general-and-jsl branch from cd8f36a to 514e8d2 Compare September 16, 2024 13:50
@philipandag
Copy link
Contributor Author

I think we have to bump to to 22.04.5 unfortunately...

Updated the link here https://github.com/Dasharo/docs/compare/cd8f36aca6860d501b9b2d1c93612d9d10cb9b6b..514e8d2984c88cf61ecce44791828abe5ec23a5f

@miczyg1 miczyg1 merged commit 514e8d2 into master Sep 16, 2024
4 checks passed
@miczyg1 miczyg1 deleted the 10C-Docs-Reorganize-general-and-jsl branch September 16, 2024 13:52
@miczyg1 miczyg1 mentioned this pull request Sep 17, 2024
Merged
@krystian-hebel krystian-hebel mentioned this pull request Sep 24, 2024
Merged
miczyg1 added a commit that referenced this pull request Oct 16, 2024
@miczyg1
mkdocs.yml: Add missing redirects
7be93ba 
Redirects dropped by a bad rebase/squash from PR
#851

Signed-off-by: Michał Żygowski <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@miczyg1 miczyg1 miczyg1 approved these changes

@mkopec mkopec mkopec approved these changes

@BeataZdunczyk BeataZdunczyk Awaiting requested review from BeataZdunczyk

@macpijan macpijan Awaiting requested review from macpijan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@philipandag @mkopec @miczyg1 @macpijan