gleachkr
commented
4 years ago Sounds good. I think we should probably move documentation out of the "shared" system once this is ready to go. That will simplify things considerably.
On Thu, Sep 24, 2020, 12:37 PM Richard Zach notifications@github.com wrote:
Well, I haven't done anything yet, since I didn't want to put in work I'd have to undo because the documentation I start from has changed.
I suggest the way to do this is:
- implement the scripts/Github action/cron job that pulls the MD files from here and changes them on the server when they change in the repo;
- populate the repo with existing documentation, and freeze the documentation;
- test if it works ok;
- when it works, start improving the documentation incrementally, and make any changes to existing documentation here only.
If we want the documentation to remain in the shared files and be searchable/filterable by tag there, the script that inserts the MD file will need a way to take/overwrite things like page title, description, tags, and possibly restrictions (if we want some things only be available to instructors, say, although since this repo is public, maybe everything can just be public).
— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/Carnap/Carnap-Documentation/issues/1, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABQWOFKGN4B72CTLEYMAJMTSHN7UDANCNFSM4RYSSTNQ .
lf-
rzach
Well, I haven't done anything yet, since I didn't want to put in work I'd have to undo because the documentation I start from has changed.
I suggest the way to do this is:
If we want the documentation to remain in the shared files and be searchable/filterable by tag there, the script that inserts the MD file will need a way to take/overwrite things like page title, description, tags, and possibly restrictions (if we want some things only be available to instructors, say, although since this repo is public, maybe everything can just be public).