Skip to content
This repository has been archived by the owner on Jun 8, 2020. It is now read-only.

conversion of existing documentation resources to markdown in preparation for improved site launch #200

Closed
MaxDiz opened this issue Apr 9, 2020 · 5 comments
Labels
documentation product and user documentation

Comments

@MaxDiz
Copy link

MaxDiz commented Apr 9, 2020

As part of the review of existing documentation (#195) we will work out which documentation resources should be migrated to the improved documentation site. If a resource is in a format other than markdown, it will need to be converted. This issue is to capture all resources that need to be converted to markdown in preparation for documentation site launch.

@MaxDiz MaxDiz added the documentation product and user documentation label Apr 9, 2020
@MaxDiz MaxDiz added this to To do in Documentation Squad Jog 1 via automation Apr 9, 2020
@MaxDiz MaxDiz changed the title migration of existing documentation resources to improved site at time of launch conversion of existing documentation resources to markdown in preparation for improved site launch Apr 15, 2020
@MaxDiz
Copy link
Author

MaxDiz commented Apr 15, 2020

The CHT overview slidedeck is our best, single source of product information currently. It is in goog slides/pdf format currently and needs to be converted in its entirety to 'seed' the new documentation site.

@abbyad this will be an extended task for anyone on our current documentation squad/broader team to complete. I'm concerned that it will slow down progress on launching the new site. Could we engage a 3rd party (perhaps through a gig economy site) to help expedite the conversion?

@MaxDiz MaxDiz moved this from To do to In progress in Documentation Squad Jog 1 Apr 21, 2020
@MaxDiz
Copy link
Author

MaxDiz commented Apr 21, 2020

@CescaGarrett can you please link to the goog slides version of the CHT overview deck?

@CescaGarrett
Copy link
Contributor

@MaxDiz here you go!

@abbyad
Copy link
Contributor

abbyad commented Apr 25, 2020

The CHT overview was converted to Markdown in this commit. All the text except for the reference workflows has been brought in, and restructured to generally fit the new format and doc index.

Still to do:

  • Keep pulling in other content, reorganizing content as needed
  • Bring in images
  • tweak the language for a doc site vs the slide deck (eg change "we use").

@MaxDiz
Copy link
Author

MaxDiz commented Jun 4, 2020

completed for initial launch. Additional issues are being created for follow-up items

@MaxDiz MaxDiz closed this as completed Jun 4, 2020
Documentation Squad Jog 1 automation moved this from In progress to Done Jun 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation product and user documentation
Projects
No open projects
Development

No branches or pull requests

3 participants