Problem/Motivation

The architecture of CRM is not documented outside of code.

Proposed resolution

Document it!

Remaining tasks

  1. Draft documentation (base it on #3522261: Improve project description)
  2. Add to documentation site

Issue fork crm-3522273

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

jdleonard created an issue. See original summary.

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Related issues: +#3522268: Create documentation site using Gitlab Pages and MkDocs
jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Issue summary: View changes
Related issues: +#3522261: Improve project description
jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Component: Code » Documentation
jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Assigned: Unassigned » jdleonard
Issue summary: View changes

jdleonard opened merge request !33

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Assigned: jdleonard » Unassigned
Status: Active » Needs work

Made a good start. Unassigning so others can pick it up until I'm next available.

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Assigned: Unassigned » jdleonard

bluegeek9 made their first commit to this issue’s fork.

bluegeek9 changed the visibility of the branch 1.0.x to hidden.

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented
Assigned: jdleonard » Unassigned
Status: Needs work » Needs review

What I've done is ready for review. I'm sure plenty more could be written.

If what's there is good enough, I propose getting it merged promptly so we can include architecture docs updates in each issue that affects the architecture.

I created a follow-up issue to document and tidy up access control and permissions: #3527151: Document and tidy access control and permissions

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented

Will need to follow up to document changes from:
#3525151: Rename Individual to Person
#3525360: Make External Identifiers field optional

bluegeek9’s picture

bluegeek9 commented

Do the Diagrams render? The one I included did not.
https://project.pages.drupalcode.org/crm/relationship/

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented

Not sure how to verify whether it will render on GitLab Pages pre-merge (created #3527319: Ability to preview GitLab Pages in CI). I do see that your diagram isn't rendering on GitLab Pages. That feels like a GitLab Pages bug, but I can't find anything recent online about it.

https://git.drupalcode.org/issue/crm-3522273/-/blob/3522273-document-crm... shows a syntax error for mine, but I think that's expected because I'm using a GitLab Pages specific syntax to include the diagram and I wouldn't expect it to function at the above URL.

jdleonard’s picture

jdleonard
he/him
Primary language English
Location Austin, Texas
commented

I found https://mkdocs-mermaid2.readthedocs.io/en/latest/superfences/#usage-for-... which proposed a different way to get Mermaid rendering. Might be worth a try.

bluegeek9 closed merge request !33

bluegeek9 opened merge request !89

bluegeek9’s picture

bluegeek9 commented
Status: Needs review » Fixed
//www.flaticon.com/free-icons/thank-you Thank you for your contribution! Your continued support makes this project sustainable.
There are multiple ways to show appreciation for the work contributed to this project including:
  • Triage issues and adding more context to existing issues.
  • Flagging CRM as a favorite on the project page to help others discover it and show your support.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.