belforte
commented
2 years ago Can you kick this off by migrating a couple pages from twiki to MD ? I.e. example of same content with different syntax. It would be agreat reference for people like me.
Open novicecpp opened 2 years ago
belforte
commented
2 years ago Can you kick this off by migrating a couple pages from twiki to MD ? I.e. example of same content with different syntax. It would be agreat reference for people like me.
novicecpp
commented
2 years ago Please see Migrating from Twiki on how to migrate with pandoc and output/result of "CRAB Client Installation" page.
Also, see Style Guide and how to use mkdocs serve to view the result of MkDocs in your local machine.
novicecpp
commented
1 year ago Progress on migrating to mkdocs.
Status description:
| Twiki | mkdocs | status | owner | note |
|---|---|---|---|---|
| New operator TODO list | Operators/Day1/New Member Setup | INPROGRESS | tseethon | |
| =========Installation========= | ||||
| CRAB3 frontend installation | It can merge into CRAB REST in mkdocs. | |||
| CRAB Docker and Kubernetes | It can merge into CRAB REST in mkdocs. | |||
| CRAB TaskWorker Install CRAB3 Task Worker installation | Technical/CRAB TaskWorker | REVIEW | tseethon | |
| CRAB Publisher installation | It should have separate page in Technical section, but point installation step to Technical/CRAB TaskWorker/Deploy. | |||
| TW and Publisher deployment on Docker | It can merge into deployment section in Technical/CRAB TaskWorker/Deploy | |||
| CRAB3 Schedd (Deprecated) CRAB3 Schedd installation and deployment | Technical/CRAB Schedd | REVIEW | tseethon | |
| CRAB3 client (Deprecated) CRAB3 client installation | Technical/CRAB Client | REVIEW | tseethon | |
| ASO installation and deployment | TO_BE_DEPRECATE | |||
| Notes about server deployment | Not sure where it belongs in the new docs. | |||
| CRAB logstash deployment on K8s | Seperate section to discuss about logging? | |||
| ========== Technical Documentation =========== | ||||
| CRAB Overview | Technical/CRAB Overview | REVIEW | belforte | (Wa) Can we split authn/authz part to another section in Technical? |
| Operator debugging tips | It should be one page dedicate to collections of FAQ, like "CRAB3 frequently asked questions", but for operators. | |||
| CRAB3 State Machine | ||||
| Notes about CRAB3 service Certificates management | It can merge into Technical/CRAB TaskWorker/Introduction | |||
| Notes about CRAB3 Oracle Database management | It can merge into Technical/CRAB REST/Database, or dedicate section about Oracle database | |||
| Inside Documentation | (Wa: what is intention of this page?) | |||
| CRAB3 Puppet | Technical/CRAB Puppet | REVIEW | tseethon | |
| Rucio Cheat Sheet | ||||
| CRAB Web Site | (Wa: what is intention of this page?) | |||
| =======Other useful documents, not in Twiki =========== | Should we move to mkdocs? | |||
| getting started on using S3 for CRAB | ||||
| CRAB K8s clusters | ||||
| CRAB Prodution update | ||||
| S3 for CRAB | ||||
| S3 CRAB Cache | ||||
| CRAB python3 memory studies | ||||
| ======== Build and Release management | ||||
| Notes about CRAB3 release management | ||||
| Notes about CRAB3 validation | ||||
| Notes about CRAB3 CI/CD | ||||
| Notes about CRAB3 testing | ||||
| ======= mkdocs: Technical section ======== | ||||
| Technical/CRAB Inventory | REVIEW | dmapelli | ||
| RAB Monitoring: | INPROGRESS | tseethon | ||
| CRAB REST: | INPROGRESS | tseethon | ||
| CRAB Secrets: | DONE | |||
| ===== (page that does not belong to any section in Technical) ==== | We should move it to new/existing sections. | |||
| CRABServer cache s3 timeouts | REVIEW | dmapelli | ||
| CRABServer REST stress test | REVIEW | dmapelli | ||
| CRABServer timber timestamps | REVIEW | dmapelli | ||
| CRAB User Troubleshooting | REVIEW | tseethon | ||
| Data Processing in CMS with CRAB | REVIEW | belforte | ||
| Data transfer in CMS | REVIEW | belforte | ||
| How are CRAB DAGs controlled | REVIEW | belforte | ||
| CRAB Disaster Recovery and Backup | INPROGRESS | tseethon |
My proposal on how we start migrating documents from Twiki to Markdown is below. Feel free to add any suggestions and comments.
Goal (Definition of Done) All operational documents are migrated from Twiki to Markdown.
Scope
How
Sounds goods, doesn't work.
I would like to ask everyone to pledge their work hours on Friday to create/migrate/update pages in Markdown.Expected 1 page per week.If we start this week (week 28), we will get a total of 24 pages per person by the end of this year, which is a lot.TODO