Document Standardization (wiki framework) Meeting Minutes
Meeting Info ¶
| Date | 2022-04-28 |
|---|---|
| Topic | Monitoring & Status Document Standardization - Wiki Framework |
| Attendee | Calvin Yan, Selly Huang, Rocky Chi, Daniel Zhou, Ted Zhao, Jackson Liu, Albert Wang |
| Note Taker | Rocky Chi |
| Timer | Selly Huang |
| Duration | 50 minutes |
Meeting Agenda ¶
Finalize Team NAME(5mins) ¶
- previously suggested: tiger, collie, 「XX特工队？」, eagle
- new： Holy Eagle Agents 4, Collie Internal Agents
Where to put document(15mins) ¶
agreement here is, readme.md is important, and there should be Search function. - Rich text or markdown - if markdown, need a team-wide sharing? - Where to place OUR document, Customer wiki, and developer wiki
How to organize wiki(10mins) ¶
structured wiki design - brainstorm and come up with a prototype about the basic structure (aspect / function...)
Meeting Minutes & Action Items: ¶
outputs of the meeting lists as below.
Rule Level ¶
- mandatory
- recommend
- reference
Team NAME - Holy Eagle Agents (HEA) ¶
Where to put document: ¶
- Write wiki by
markdown, and put it to GitHug Pages - https://sqbu-github.cisco.com/ - Wiki Functions Needed: search, navigator, archive, tag cloud, comments (github issue / jira), history, visit rate
Next step: evalute effort to migrate project from bitbucket to github (MCT and EMS)
Organize Wiki ¶
- Wiki design - 面向不同对象，文案不同目的涉及到的结构都会不太一样。不过目录，文案背景两块结构大致都需要。在一级二级三级副标题内容等各有不同。
- Privilege: for two types of wiki, same project, different path.
- Have a universal portal for Monitoring & Alerting, privilege control can be done here.
- Wiki Content - Get Started: mandatory - Glossary: mandatory - Categorize by Sub Project: recommend - Internal Wiki: architecture oriented; Customer Wiki: functional oriented - recommend