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

Connector help rework #4082

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

SimonV-Skyline
Copy link
Member

No description provided.

@SimonV-Skyline SimonV-Skyline requested a review from a team as a code owner December 19, 2024 13:53
@SimonV-Skyline SimonV-Skyline marked this pull request as draft December 19, 2024 13:53
@SimonV-Skyline SimonV-Skyline marked this pull request as ready for review December 19, 2024 14:11
@SimonV-Skyline
Copy link
Member Author

I've added Jarno as a reviewer because I'd like to get his input but note I don't think we need to wait on his review.
@SkylineCommunications/team-docs-reviewers, once you've applied your magic, feel free to release. We can always take the remarks from Jarno to make further improvements as a second step.

The title of the page should be the name of the connector in the [DataMiner Catalog](https://catalog.dataminer.services/).
The title of both pages should be the name of the connector in the [DataMiner Catalog](https://catalog.dataminer.services/).

### Marketing page
Copy link
Member

Choose a reason for hiding this comment

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

This more or less in line with https://docs.dataminer.services/user-guide/Cloud_Platform/Catalog/Best_Practices_When_Documenting_Catalog_Items.html.
Can we not simply make a reference to these guidelines?

Copy link
Member

Choose a reason for hiding this comment

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

Since there are some differences, it depends on whether you want to bring the connector pages fully in line with those for other Catalog items. If yes, we can largely replace this text with a reference and just add that a link must be added to the technical page. Otherwise, I could also add a tip referring to the best practices page for general best practices (e.g. the use of visuals).

@MariekeGO MariekeGO self-assigned this Jan 6, 2025
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