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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc/user: update "Tools and Integrations" #12018

Merged
merged 6 commits into from
Apr 25, 2022

Conversation

morsapaes
Copy link
Contributor

@morsapaes morsapaes commented Apr 24, 2022

馃憠 Preview link

Motivation

The refurbished "Tools and Integrations" page adds a great overview of the level of support for different tools in Materialize, but the content is a bit too heterogeneous. This PR suggests a few changes to improve readability and discoverability:

  • Break sections with too many tools into sub-sections and give tools supported as sources and sinks a dedicated section (e.g. not including Redpanda under "Kafka").
  • Instead of providing technical details under "Notes", more clearly state the status of the integration and link to existing guides or tracking issues for further details.
  • Rewrite intro sections so that there's more consistency between sections and include technical details that are common to all tools in those sections (e.g. enabling logical replication is required for all listed PostgreSQL integrations, so it can be called out once instead of 10x).
  • Make "Notify Me" buttons similar in style to the existing copy buttons.
  • Remove trailing list of links at the bottom of the page.

@ruf-io, I couldn't figure out where to change the text of &.level-in-development (at least not without borking the icons!); if we made it "In Progress", we could avoid the line break.


Once this is settled, the changes need to be backported to the lts-docs branch. As a follow-up, we should create the following integration guides:

@morsapaes morsapaes requested a review from ruf-io April 25, 2022 08:09
@morsapaes morsapaes added the A-docs Area: documentation label Apr 25, 2022
Copy link
Contributor

@ruf-io ruf-io 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 way better!

To fix the s/in-development/in-progress/ issue, literally search and replace all occurrences of in-development:

  1. In the key table at the top of page
  2. In rows where it is used
  3. in content.scss line 713
  4. in inline-svgs.html line 4

doc/user/content/integrations/_index.md Outdated Show resolved Hide resolved
@morsapaes
Copy link
Contributor Author

in inline-svgs.html line 4

Ah! This was the bit I missed! Thank you, @ruf-io! Will change that and blend in your suggestions.

@morsapaes morsapaes merged commit 67d311a into MaterializeInc:main Apr 25, 2022
morsapaes added a commit to morsapaes/materialize that referenced this pull request Apr 25, 2022
* Make content tighter and more consistent

* Style buttons in the same way as existing copy buttons

* Set disable_list: true to avoid list of links at the bottom of the page

* Adjust Notes for ORMs

* Fix linting

* s/in-development/in-progress
morsapaes added a commit to morsapaes/materialize that referenced this pull request Apr 25, 2022
* Make content tighter and more consistent

* Style buttons in the same way as existing copy buttons

* Set disable_list: true to avoid list of links at the bottom of the page

* Adjust Notes for ORMs

* Fix linting

* s/in-development/in-progress
morsapaes added a commit that referenced this pull request Apr 25, 2022
Improve content and ensure consistent styling with other documentation pages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants