Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Removed the "cc-catalog" references from the system-architecure diagram. #771

Merged
merged 4 commits into from
Jul 3, 2022

Conversation

raghuvar-arora-au2
Copy link
Contributor

Fixes

Fixes #758 by @sarayourfriend

Description

Recreated the diagram in draw.io, and removed the cc-catolog references.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@raghuvar-arora-au2 raghuvar-arora-au2 requested a review from a team as a code owner June 24, 2022 18:52
@raghuvar-arora-au2
Copy link
Contributor Author

Where should I put the XML file and the link to the draw.io project?

@openverse-bot openverse-bot added 📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed labels Jun 24, 2022
@zackkrida
Copy link
Member

@raghuvar-arora-au2 how about moving all of this into a subdirectory of the readme_assets folder, maybe something like:

readme_assets
└── system_diagram
    ├── diagram.png
    ├── diagram.xml
    └── readme.md

and then the link to draw.io could go in that readme file? if you do it this way, make sure to update path to the image in the repo README file.

The diagram looks excellent! Thanks for this.

@raghuvar-arora-au2
Copy link
Contributor Author

Made the changes, thanks

Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

This is great @raghuvar-arora-au2! It looks like you'll need to run just lint at the root of the repository and commit the changes to the markdown file, but otherwise this is great to see 🙂

I left a couple things that would be nice to update while we're making this change as well.

Additionally, I don't think the shares.cc service is running anymore, but maybe @zackkrida could confirm that. We might want to remove that block as well.

Thanks again for the contribution!!

<mxCell id="JVIGxF9oKAkimninJbSp-58" value="-Search queries&lt;br&gt;-Tag Stats&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;&amp;nbsp;" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" vertex="1" parent="1">
<mxGeometry x="770" y="350" width="110" height="40" as="geometry" />
</mxCell>
<mxCell id="JVIGxF9oKAkimninJbSp-59" value="-Site cache&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;&amp;nbsp;&lt;br&gt;-Traffic stats&amp;nbsp; &amp;nbsp; &amp;nbsp;&amp;nbsp;&lt;br&gt;-Dead link cache" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" vertex="1" parent="1">
Copy link
Contributor

Choose a reason for hiding this comment

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

We no longer hold traffic stats anywhere as far as I am aware, so I think we can remove that bit.

Suggested change
<mxCell id="JVIGxF9oKAkimninJbSp-59" value="-Site cache&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;&amp;nbsp;&lt;br&gt;-Traffic stats&amp;nbsp; &amp;nbsp; &amp;nbsp;&amp;nbsp;&lt;br&gt;-Dead link cache" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" vertex="1" parent="1">
<mxCell id="JVIGxF9oKAkimninJbSp-59" value="-Site cache&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;&amp;nbsp;&lt;br&gt;-Dead link cache" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" vertex="1" parent="1">

readme_assets/system_diagram/system_architecture.xml Outdated Show resolved Hide resolved
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Thank you for amazing work, @raghuvar-arora-au2 !

There are a couple of things that we don't have anymore, could you please remove them. I've scratched them out in the screenshot below:
Screen Shot 2022-06-27 at 2 34 04 PM

@stacimc
Copy link
Contributor

stacimc commented Jun 27, 2022

This is looking great! 🎉

Can we update the text "Ingest" here to say "Data refresh"? Context in comment. (I do think it's correct to keep the phrase "Ingestion server", since the server is currently named that).

Screen Shot 2022-06-27 at 2 34 04 PM

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

The new diagram is very nice! Thanks @raghuvar-arora-au2.

I'm not sure if we should be including the frontend in the diagram that's in the API repo, but it's not wrong so not a problem.

One technical change in the "API Database" ↔ "API Server Group" link is that we no longer have link shortening data and lists. Those tables exist but that functionality has been deactivated.

Also a couple of grammatical improvements:

  • "Django-api" → "Django API"
  • "frontend" → "Frontend"

<mxCell id="JVIGxF9oKAkimninJbSp-10" value="API Server Group&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;&lt;br&gt;" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
<mxGeometry x="435" y="430" width="300" height="130" as="geometry" />
</mxCell>
<mxCell id="JVIGxF9oKAkimninJbSp-12" value="Django-api" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<mxCell id="JVIGxF9oKAkimninJbSp-12" value="Django-api" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
<mxCell id="JVIGxF9oKAkimninJbSp-12" value="Django API" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">

<mxCell id="JVIGxF9oKAkimninJbSp-12" value="Django-api" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
<mxGeometry x="455" y="480" width="80" height="40" as="geometry" />
</mxCell>
<mxCell id="JVIGxF9oKAkimninJbSp-13" value="Django-api" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<mxCell id="JVIGxF9oKAkimninJbSp-13" value="Django-api" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
<mxCell id="JVIGxF9oKAkimninJbSp-13" value="Django API" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">

<mxCell id="JVIGxF9oKAkimninJbSp-13" value="Django-api" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
<mxGeometry x="545" y="480" width="80" height="40" as="geometry" />
</mxCell>
<mxCell id="JVIGxF9oKAkimninJbSp-14" value="Django-api" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<mxCell id="JVIGxF9oKAkimninJbSp-14" value="Django-api" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">
<mxCell id="JVIGxF9oKAkimninJbSp-14" value="Django API" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" vertex="1">

<mxCell id="JVIGxF9oKAkimninJbSp-15" value="Load Balancer" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#dae8fc;strokeColor=#6c8ebf;" parent="1" vertex="1">
<mxGeometry x="525" y="590" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="JVIGxF9oKAkimninJbSp-16" value="frontend" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#f8cecc;strokeColor=#b85450;" parent="1" vertex="1">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<mxCell id="JVIGxF9oKAkimninJbSp-16" value="frontend" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#f8cecc;strokeColor=#b85450;" parent="1" vertex="1">
<mxCell id="JVIGxF9oKAkimninJbSp-16" value="Frontend" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=1;fillColor=#f8cecc;strokeColor=#b85450;" parent="1" vertex="1">

<mxCell id="JVIGxF9oKAkimninJbSp-64" value="Other infrastructure" style="shape=partialRectangle;html=1;whiteSpace=wrap;connectable=0;fillColor=#dae8fc;top=0;left=0;bottom=0;right=0;overflow=hidden;pointerEvents=1;align=left;spacingLeft=10;strokeWidth=1;strokeColor=#6c8ebf;" parent="JVIGxF9oKAkimninJbSp-62" vertex="1">
<mxGeometry y="30" width="180" height="30" as="geometry" />
</mxCell>
<mxCell id="JVIGxF9oKAkimninJbSp-65" value="External dependancy" style="shape=partialRectangle;html=1;whiteSpace=wrap;connectable=0;fillColor=#f8cecc;top=0;left=0;bottom=0;right=0;overflow=hidden;pointerEvents=1;align=left;spacingLeft=10;strokeWidth=1;strokeColor=#b85450;" parent="JVIGxF9oKAkimninJbSp-62" vertex="1">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<mxCell id="JVIGxF9oKAkimninJbSp-65" value="External dependancy" style="shape=partialRectangle;html=1;whiteSpace=wrap;connectable=0;fillColor=#f8cecc;top=0;left=0;bottom=0;right=0;overflow=hidden;pointerEvents=1;align=left;spacingLeft=10;strokeWidth=1;strokeColor=#b85450;" parent="JVIGxF9oKAkimninJbSp-62" vertex="1">
<mxCell id="JVIGxF9oKAkimninJbSp-65" value="External dependency" style="shape=partialRectangle;html=1;whiteSpace=wrap;connectable=0;fillColor=#f8cecc;top=0;left=0;bottom=0;right=0;overflow=hidden;pointerEvents=1;align=left;spacingLeft=10;strokeWidth=1;strokeColor=#b85450;" parent="JVIGxF9oKAkimninJbSp-62" vertex="1">

<mxCell id="JVIGxF9oKAkimninJbSp-59" value="-Site cache&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;&amp;nbsp;&amp;nbsp; &amp;nbsp; &amp;nbsp;&amp;nbsp;&lt;br&gt;-Dead link cache" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxGeometry x="590" y="360" width="125" height="41" as="geometry" />
</mxCell>
<mxCell id="JVIGxF9oKAkimninJbSp-60" value="-Detail views&lt;br&gt;-Lists&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;&lt;br&gt;-Content provider data&lt;br&gt;&lt;div style=&quot;&quot;&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;-Link shortening data&lt;/span&gt;&lt;/div&gt;" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<mxCell id="JVIGxF9oKAkimninJbSp-60" value="-Detail views&lt;br&gt;-Lists&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;&lt;br&gt;-Content provider data&lt;br&gt;&lt;div style=&quot;&quot;&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;-Link shortening data&lt;/span&gt;&lt;/div&gt;" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">
<mxCell id="JVIGxF9oKAkimninJbSp-60" value="-Detail views&lt;br&gt;-Lists&amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp; &amp;nbsp;&lt;br&gt;-Content provider data&lt;br&gt;&lt;div style=&quot;&quot;&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;&lt;/span&gt;&lt;/div&gt;" style="text;html=1;align=left;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;" parent="1" vertex="1">

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure that this suggestion will work for PNG generation, but we should remove the Link shortening data here, too.

@raghuvar-arora-au2 raghuvar-arora-au2 requested a review from obulat July 3, 2022 02:01
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution, @raghuvar-arora-au2 ! The diagram looks great 🎉

@obulat obulat merged commit 5d1eaed into WordPress:main Jul 3, 2022
@AetherUnbound
Copy link
Contributor

Just dropping in to say thanks so much for this contribution @raghuvar-arora-au2! This is excellent 🥳

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove CC-Catalog references in API docs diagram in readme
8 participants