docs icon indicating copy to clipboard operation
docs copied to clipboard

10c docs reorganize general and jsl

Open philipanda opened this issue 1 year ago • 4 comments

philipanda avatar Jul 03 '24 12:07 philipanda

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

philipanda avatar Jul 25 '24 05:07 philipanda

@philipandag some conflicts related to whitespace in mkdocs.yml

mkopec avatar Aug 02 '24 11:08 mkopec

@mkopec conflicts resolved

philipanda avatar Aug 05 '24 09:08 philipanda

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

philipanda avatar Aug 09 '24 11:08 philipanda

@philipandag pay attention to SEO CI linkChecker result, it will show you broken links you should fix

miczyg1 avatar Sep 16 '24 09:09 miczyg1

@philipandag pay attention to SEO CI linkChecker result, it will show you broken links you should fix

Does it run every time? After 54 minutes the pre-commit still waits in a queue and linkChecker is not even queued...

philipanda avatar Sep 16 '24 11:09 philipanda

@philipandag maybe the conflicts are the problem? https://results.pre-commit.ci/run/github/316342881/1726483030.37ik4OnHQ-murFa2tCVN6w

miczyg1 avatar Sep 16 '24 11:09 miczyg1

@philipandag even more conflicts now :)

miczyg1 avatar Sep 16 '24 11:09 miczyg1

@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.

philipanda avatar Sep 16 '24 12:09 philipanda

@miczyg1 What to do with these orphaned pages?

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

philipanda avatar Sep 16 '24 12:09 philipanda

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

philipanda avatar Sep 16 '24 12:09 philipanda

@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?

philipanda avatar Sep 16 '24 13:09 philipanda

@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 avatar Sep 16 '24 13:09 miczyg1

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 avatar Sep 16 '24 13:09 miczyg1

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

miczyg1 avatar Sep 16 '24 13:09 miczyg1

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?

philipanda avatar Sep 16 '24 13:09 philipanda

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.

philipanda avatar Sep 16 '24 13:09 philipanda

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.

mkopec avatar Sep 16 '24 13:09 mkopec

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

miczyg1 avatar Sep 16 '24 13:09 miczyg1

Updated the commit message. https://github.com/Dasharo/docs/pull/851/commits/514e8d2984c88cf61ecce44791828abe5ec23a5f

philipanda avatar Sep 16 '24 13:09 philipanda

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

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

philipanda avatar Sep 16 '24 13:09 philipanda