Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate docs docs.datajoint.org #18

Merged
merged 12 commits into from
Nov 9, 2022
Merged

Migrate docs docs.datajoint.org #18

merged 12 commits into from
Nov 9, 2022

Conversation

CBroz1
Copy link
Contributor

@CBroz1 CBroz1 commented Nov 4, 2022

Before merge, we should

  1. Merge Hard wrap existing docs, Tabbed blocks #17 (hard wrapping of existing materials)
  2. Decide the merge order of this PR vs. Revamp user tutorial #14 - After discussion, I'll pull commits accordingly

For this PR, I ...

  1. Collected all docs from docs.datajoint.org and all snippets from datajoint-python and datajoint-matlab
  2. Converted previous .rst docs into markdown, including tabbing markers for python- vs. matlab-specific content
  3. Moved all docs into an archive folder in this repo, which includes the following subfolders
    • _planned_archive: I believe this material should be archived as we migrate to more user-friendly language
    • _to_python_matlab: These are the materials that remain after I took out general information. In future PRs, I plan to delete the contents here and load into their respective docs sits. Maybe next week?
    • _to_include: Remaining docs are here. These are candidates for inclusion that could be pulled from to continue adding docs in the future.
  4. Added a number of pages, revising existing content to be more new-user friendly
  5. Generated updated figures and mermaid diagrams to fit updated branding. Some of these came from google sheets/slides - where on google drive should they be stored?

@CBroz1 CBroz1 marked this pull request as ready for review November 4, 2022 22:37
src/FAQ.md Outdated Show resolved Hide resolved
Co-authored-by: Dimitri Yatsenko <dimitri@datajoint.com>
Co-authored-by: Kabilar Gunalan <kabilar@datajoint.com>
src/community/support.md Outdated Show resolved Hide resolved
CBroz1 and others added 2 commits November 9, 2022 15:20
Co-authored-by: Kabilar Gunalan <kabilar@datajoint.com>
Co-authored-by: Kabilar Gunalan <kabilar@datajoint.com>
Copy link
Collaborator

@kabilar kabilar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @CBroz1! Huge effort here on this migration.

I did not review all the text in detail, but our team will collectively review and update over the next 1-2 months.

Let's merge #14 after this pull request. We can keep the the Google Slides/Sheets in the U24 folder for now, and find a way to add those files to this repo in the future.

@kabilar kabilar merged commit d5097bb into datajoint:main Nov 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants