TF Manual conversion to hero mdbook #37

New Issue

mik-tf · 2024-04-17T17:26:02Z

mik-tf commented

2024-04-17 17:26:02 +00:00

Situation

TF Manual conversion to hero mdbook is done apart from things to fix with hero or adjust:

we need to be able to set a book.toml file
we need to be able to set a theme directory with .hbs file
we need to allow include (!!wiki.include) in tables (issue on GH for 3 first points)
we need to fix URLs conversion from mdbook to hero mdbook (issue on GH)
we need to fix how hero mdbook conversion of ``` text ``` section with spaces between the quotes and the beginning of the line (issue on GH)

Those points would be essential to ensure the manual doesn't lose quality when going to the hero version.

This is all documented in ongoing issues on GH: https://github.com/freeflowuniverse/crystallib/issues

@mariobassem @despiegk

Todo

Clear those issues then we can publish the manual

Notes

This version of the manual is "old" as new PRs have been merged to info_grid. We will update this in the coming weeks.

# Situation TF Manual conversion to hero mdbook is done apart from things to fix with hero or adjust: - we need to be able to set a book.toml file - we need to be able to set a theme directory with .hbs file - we need to allow include (!!wiki.include) in tables ([issue on GH for 3 first points](https://github.com/freeflowuniverse/crystallib/issues/405)) - we need to fix URLs conversion from mdbook to hero mdbook ([issue on GH](https://github.com/freeflowuniverse/crystallib/issues/408)) - we need to fix how hero mdbook conversion of \`\`\` text \`\`\` section with spaces between the quotes and the beginning of the line ([issue on GH](https://github.com/freeflowuniverse/crystallib/issues/403)) Those points would be essential to ensure the manual doesn't lose quality when going to the hero version. This is all documented in ongoing issues on GH: https://github.com/freeflowuniverse/crystallib/issues @mariobassem @despiegk # Todo Clear those issues then we can publish the manual # Notes This version of the manual is "old" as new PRs have been merged to info_grid. We will update this in the coming weeks.

despiegk commented

2024-04-23 11:24:04 +00:00

please make links to the issues you think we really need to resolve, and lets discuss
also we should make more collections e.g.
- manual_developer
- manual_ ...
- tfgrid3_knowledgebase
we should look at the errors

- please make links to the issues you think we really need to resolve, and lets discuss - also we should make more collections e.g. - manual_developer - manual_ ... - tfgrid3_knowledgebase - we should look at the errors

mik-tf was assigned by despiegk

2024-04-23 11:24:51 +00:00

despiegk self-assigned this 2024-04-23 11:25:01 +00:00

despiegk added spent time 2024-04-23 11:25:08 +00:00

30 minutes

despiegk added this to the ThreeFold 3.14 - info_tfgrid docs project 2024-04-23 11:27:31 +00:00

despiegk added the

Story

label 2024-04-23 11:29:41 +00:00

mariobassem was assigned by despiegk

2024-04-23 11:30:45 +00:00

despiegk commented

2024-04-23 12:19:11 +00:00

mario is on https://github.com/freeflowuniverse/crystallib/issues/403 and the others we will do

mik-tf commented

2024-04-23 14:32:44 +00:00

I discussed with Mario on TG, but to be clear here are the issues that would need to be prioritized:

https://github.com/freeflowuniverse/crystallib/issues/413
- WIP, I proposed a PR with the necessary changes
https://github.com/freeflowuniverse/crystallib/issues/403
https://github.com/freeflowuniverse/crystallib/issues/409

I discussed with Mario on TG, but to be clear here are the issues that would need to be prioritized: - https://github.com/freeflowuniverse/crystallib/issues/413 - WIP, I proposed a PR with the necessary changes - https://github.com/freeflowuniverse/crystallib/issues/403 - https://github.com/freeflowuniverse/crystallib/issues/409

mik-tf commented

2024-04-23 14:33:13 +00:00

I will work on a new branch, set the collections into smaller ones and make a PR when ready.

mik-tf commented

2024-04-25 01:26:29 +00:00

WIP: new branch https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/development_manual
Todo: create new manual hero mdbook with collections for each subsection
- e.g. documentation collection will become 6 collections: dashboard, sysadmin, devs, farmers, faq, threefold token
- e.g. knowledge_base will become 6 collections: about, technology, farming, cloud, collaboration, legal
if the collection name exists, we can add the prefix docs_ or manual_

- WIP: new branch https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/development_manual - Todo: create new manual hero mdbook with collections for each subsection - e.g. documentation collection will become 6 collections: dashboard, sysadmin, devs, farmers, faq, threefold token - e.g. knowledge_base will become 6 collections: about, technology, farming, cloud, collaboration, legal - if the collection name exists, we can add the prefix docs_ or manual_

mik-tf commented

2024-05-08 20:24:32 +00:00

Status: there is still an issue with the URLs from one collection to another, once this is fixed we can finish the manual conversion

mik-tf commented

2024-05-14 22:26:52 +00:00

the manual is now done with hero mdbook

mik-tf closed this issue

2024-05-14 22:26:52 +00:00

Sign in to join this conversation.

No Milestone

No project

No Assignees

2 Participants

Notifications

Total Time Spent: 30 minutes

despiegk

30 minutes

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: tfgrid/info_tfgrid#37