Update: Update README

n3philim commented

2018-12-20 15:27:31 -08:00

(Migrated from github.com)

As part of the cleanup that went into #143 (removing stale files, updating file/path names) the info in README is out of date and needs to be updated.

luciusbono commented

2018-12-20 16:16:44 -08:00

(Migrated from github.com)

Maybe this should be a separate issue, but we also have a totally out of date Wiki page: https://github.com/mozilla/dinobuildr/wiki

luciusbono commented

2018-12-20 16:17:11 -08:00

(Migrated from github.com)

(I am +1 for nuking the wiki. I think the intentions were good but this project needs a clean start.)

n3philim commented

2018-12-20 16:37:45 -08:00

(Migrated from github.com)

🤔 Sounds like we need a general "rework the documentation" epic, with a rebuild of the wiki as part of it.

It sounds like we need troubleshooting, architectural docs, a human readable list of what we're actually doing with dinobuildr for production and Corsica, and maybe some draft plans for next steps (like versioning).

🤔 Sounds like we need a general "rework the documentation" epic, with a rebuild of the wiki as part of it. It sounds like we need troubleshooting, architectural docs, a human readable list of what we're actually doing with dinobuildr for production and Corsica, and maybe some draft plans for next steps (like versioning).

n3philim commented

2018-12-21 10:54:30 -08:00

(Migrated from github.com)

Ok, working in https://github.com/mozilla/dinobuildr/tree/upd8-documentation/ I think I've got the README to a place where I'm happy with the flow, have fixed some case/tense discrepancies, and have clarified the language. I guess next I'll work on a basic contributing guide before switching over to reworking the wiki.

n3philim commented

2018-12-21 13:42:36 -08:00

(Migrated from github.com)

Updates merged in https://github.com/mozilla/dinobuildr/pull/147, closing out this issue!

Rows
Columns

Update: Update README #145