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

Add link to platform overview in docs #6239

Merged
merged 3 commits into from
Mar 7, 2024
Merged

Add link to platform overview in docs #6239

merged 3 commits into from
Mar 7, 2024

Conversation

SmittieC
Copy link
Contributor

@SmittieC SmittieC commented Mar 6, 2024

Ticket

This is a documentation update

Environments Affected

None

Copy link
Contributor

@zandre-eng zandre-eng left a comment

Choose a reason for hiding this comment

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

Just a tiny grammer comment. Looks good otherwise. I don't think there's anything more we need to add (I don't see any other relevant diagrams on HQ read-the-docs).

=====================

It is useful to have some context on what it is that you are hosting,
when you are hosting CommCare HQ.

A good place to find that context is the `Architecture Overview <https://commcare-hq.readthedocs.io/overview/architecture.html>`_
in the CommCare HQ documentation.
and the `Platform Overview <https://commcare-hq.readthedocs.io/overview/platform.html>`_ the CommCare HQ documentation.
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
and the `Platform Overview <https://commcare-hq.readthedocs.io/overview/platform.html>`_ the CommCare HQ documentation.
and the `Platform Overview <https://commcare-hq.readthedocs.io/overview/platform.html>`_ in the CommCare HQ documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See this.

=====================

It is useful to have some context on what it is that you are hosting,
when you are hosting CommCare HQ.

A good place to find that context is the `Architecture Overview <https://commcare-hq.readthedocs.io/overview/architecture.html>`_
in the CommCare HQ documentation.
and the `Platform Overview <https://commcare-hq.readthedocs.io/overview/platform.html>`_ the CommCare HQ documentation.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: There is no one way to do this, though my preference would be to not club architecture and platform links together.
Architecture is probably the most relevant link followed by the data flow diagram I shared in the ticket

So I would say we make this look something like the following:

Architecture and Platform Overview
<same as before>
Other useful links:
- [Platform overview](https://commcare-hq.readthedocs.io/overview/platform.html)

Data Flow Overview
https://commcare-hq.readthedocs.io/overview/architecture.html#data-flow-for-forms-and-cases

Copy link
Contributor

Choose a reason for hiding this comment

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

I think its fine if we skip the platform overview and add that to the architecture overview page itself.
Its quite scary and I don't think it is really useful for hosters unless someone is doing a deep understanding

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How's this?

Copy link
Contributor

Choose a reason for hiding this comment

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

Cool

@SmittieC SmittieC merged commit d5a3e9b into master Mar 7, 2024
2 checks passed
@mkangia mkangia deleted the cs/update_docs branch March 7, 2024 14:41
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