-
Notifications
You must be signed in to change notification settings - Fork 3
ADaaS revision #113
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
ADaaS revision #113
Conversation
Published docs preview URL: https://devrev-preview-54974129-d892-4616-b620-dc782d3821dc.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-375922ab-ec43-413f-964b-43379d49056e.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-34349ec4-33f0-486c-aa07-2e873e6a0410.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-7424a53a-5fbe-488b-89d1-f594ea00fa5f.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-ed13140f-f461-4dc1-9122-b797c0dcbfb2.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-17373577-db63-425a-8abf-2ea9fd74f9de.docs.buildwithfern.com |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit about the Mermaid Markdown color scheme, besides that LGTM.
fern/docs/pages/adaas/overview.mdx
Outdated
```mermaid | ||
flowchart TD | ||
%%{ | ||
init: { | ||
'theme': 'base', | ||
'themeVariables': { | ||
'fontFamily': 'Segoe UI', | ||
'lineColor': '#000', | ||
'primaryTextColor': 'white', | ||
'primaryColor': '#2a33ff', | ||
'primaryBorderColor': '#62D65D', | ||
'secondaryColor': '#5D0E1C', | ||
'tertiaryColor': '#e6e6e6', | ||
'clusterBorder': 'white' | ||
} | ||
} | ||
}%% | ||
externalSystem[External system] | ||
worker([Worker]) | ||
s3interact[s3interact] | ||
airdrop[Airdrop] | ||
s3[(AWS S3)] | ||
|
||
externalSystem <-- Get/create users, issues, ... --> worker | ||
|
||
worker <-- Exchange artifact upload/download URLs --> s3interact | ||
worker <-- Upload/download artifacts --> s3 | ||
worker <-- ADaaS messages and REST API --> airdrop | ||
|
||
|
||
subgraph DevRev | ||
s3interact <-- Prepare upload/download URL --> s3 | ||
airdrop <-- Download/upload artifacts --> s3 | ||
end | ||
|
||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just now saw you added an init function, why? Was the default color scheme not good enough?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This color scheme uses DevRev colors as specified in the Brand Guidelines. If you have a suggestion for a better way to apply those colors I'm open to it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see these exact colors in the Figma link you shared, but also, I think having the diagram nicely fit is probably preferable. If needed, we can ask one of the designers to choose a color scheme that would fit on this specific page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are correct about the colors. I now recall that I used the colors from some other diagram which, although it came from design, apparently didn't conform to the brand guidelines. I don't have time to mess around with it anymore so I have removed the color settings and just kept the font.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, IMO the default looks the best anyway. Thanks for the changes!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, my review doesn't count anyway 😂
Published docs preview URL: https://devrev-preview-581cd291-6a4d-4cce-9272-160de3196f68.docs.buildwithfern.com |
Published docs preview URL: https://devrev-preview-50cd2225-cd83-4049-a405-d6f9c5756fb0.docs.buildwithfern.com |
@radovan-jorgic @samod let me know if you have any feedback; otherwise I will merge this change tomorrow. |
https://app.devrev.ai/devrev/works/ISS-128134