-
Notifications
You must be signed in to change notification settings - Fork 278
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
SimonV-Skyline
wants to merge
9
commits into
SkylineCommunications:main
Choose a base branch
from
SimonV-Skyline:ConnectorHelp
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Connector help rework #4082
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
9bd620f
Update Connector_help_pages.md
SimonV-Skyline f235c83
Split in 2 templates and update TOC
SimonV-Skyline f0d7e88
marketing doc template
SimonV-Skyline 0bcbcfd
Update Connector_marketing_template.md
SimonV-Skyline c3bc79c
fixed couple of xref
SimonV-Skyline 14a7af7
another xref fix
SimonV-Skyline 452751e
typos
SimonV-Skyline 4001a27
another xref fix
SimonV-Skyline b2291e8
Update Connector_help_pages.md
MariekeGO File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
develop/devguide/Connector/ConnectorHelp/Connector_marketing_template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
--- | ||
uid: Connector_marketing_template | ||
--- | ||
|
||
# Connector marketing documentation template | ||
|
||
## About | ||
|
||
[Short description of the data source and of the function of the connector.] | ||
|
||
## Key Features | ||
|
||
- **Feature 1 name**: small description of feature 1. | ||
|
||
- **Feature 2 name**: small description of feature 2. | ||
|
||
- **Feature 3 name**: small description of feature 3. | ||
|
||
- **Feature 4 name**: small description of feature 4. | ||
|
||
- **Feature 5 name**: small description of feature 5. | ||
|
||
## Use Cases | ||
|
||
### Use Cases 1 | ||
|
||
**Challenge**: challenge description. | ||
|
||
**Solution**: solution description. | ||
|
||
**Benefit**: benefit(s) description. | ||
|
||
### Use Cases 2 | ||
|
||
**Challenge**: challenge description. | ||
|
||
**Solution**: solution description. | ||
|
||
**Benefit**: benefit(s) description. | ||
|
||
### Use Cases 3 | ||
|
||
**Challenge**: challenge description. | ||
|
||
**Solution**: solution description. | ||
|
||
**Benefit**: benefit(s) description. | ||
|
||
## Technical info | ||
|
||
### Prerequisites | ||
|
||
- **Prerequisite 1** is needed for... | ||
|
||
- **Prerequisite 2** are needed for... | ||
|
||
- **Prerequisite 3** is required for... | ||
|
||
> [!NOTE] | ||
> For detailed technical information, refer to our [technical documentation](xref:Connector_help_My_connector_name_Technical). |
4 changes: 2 additions & 2 deletions
4
.../ConnectorHelp/Connector_help_template.md → ...ectorHelp/Connector_technical_template.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 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?
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.
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).