Page MenuHomePhabricator
Create Task
Maniphest T62

Keep Dreaming Project | User Guides and Templates
Open, Good First IssuePublic
Actions

Description

With a bunch of different complicated services having some user guides and templates would be incredibly helpful.

BookStack is pretty straight forward but pointing out some of its features as well as any work arounds would be good. A couple of different templates along with example chapters/pages would be helpful to encourage consistency.

Phabricator has a lot of stuff going on and the official documentation can be a bit lacking. This will easily be the most annoying one. Fortunately we don't need a lot of the features so we only need to focus on the major ones. Basic templates for everything would be great.

DocDokuPLM TBD Switched to InvenTree R41

Related Objects

Duplicates Merged Here
T51: Templates

Event Timeline

zeigren lowered the priority of this task from Needs Triage to High.Nov 28 2019, 12:56 PM
zeigren created this task.
zeigren lowered the priority of this task from High to Good First Issue.Nov 30 2019, 9:04 PM
zeigren merged a task: T51: Templates.
zeigren updated the task description. (Show Details)Jan 19 2020, 9:57 AM
zeigren added a comment.Jan 19 2020, 10:10 AM

I plan on adopting VSCode as the recommend text editor for the project and basing any code related guides around it.

The "How to use Arcanist" guide for Phabricator should use the VSCode Phabricator extension.

For SystemVerilog I'll recommend the Verilog HDL/SystemVerilog VSCode extension, I'll have to rewrite QMSV R10 for VSCode.

zeigren moved this task from General to User Guides and Templates on the Keep Dreaming Project Meta board.Jan 19 2020, 4:55 PM