Hey Folks -

We discussed the desire to do this migration in the past and agreed to move
our docs site into the repo alongside the code itself.

This has already been done but the 2.1.0 release has gone out before we
have made the official link to docs be the new deployment. There are a
couple reasons for this:

1. We still need to spin up a "Docathon" to fix broken links, images and
pages with inappropriate formatting or missing text.
2. We need to decide whether and how to support versions of the docs. I am
currently leaning toward the docs being part of the release artifacts that
can be downloaded for previous versions and the live site being the
current/most recent release. It is unclear to me how we would deal with
docs for main that shouldn't be live yet. This needs some thought and
discussion. Maybe this is already something built into git pages and a
simple investigation.

In order to burn down the outstanding issues, I feel like we need to treat
this Docathon as a little mini release where the issues have to be
identified with JIRAs filed and a community effort to burn them down. We
could even maybe add a release version specific for this effort that is
distinguishable as a doc release? Thoughts?

We would need to file a JIRA for that "release" for the versioning details
described above as well.

What are your thoughts in general and specifically on the above?
Does anyone have any other considerations that we need to include as well
as the above?

thanks,

--larry

Reply via email to