📚 Update documentation best practices #3870
Merged
Conversation
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
avaidyanatha
reviewed
Jun 3, 2021
| * how to build and run the code locally & via Docker | ||
| * any other information needed for local iteration | ||
|
|
||
| ### Changelogs |
There was a problem hiding this comment.
We should have people use this format for consistency:
Changelog
| Version | Date | Pull Request | Subject |
| :------ | :-------- | :----- | :------ |
| 0.2.0 | 20XX-05-XX | [PR2#](https://github.com/airbytehq/airbyte/pull/PR2#) | description |
| 0.1.0 | 20XX-04-XX | [PR#](https://github.com/airbytehq/airbyte/pull/PR#) | description |
There was a problem hiding this comment.
@sherifnada Abhi and I are adding the changelog into the connector documentation.
| Below are some best practices related to each of these. | ||
|
|
||
| ### READMEs | ||
| Every module should have a README containing: |
There was a problem hiding this comment.
Maybe a section on setting up the source/destination in the UI, explaining the fields?
There was a problem hiding this comment.
this kind of info goes into the docs/ documentation (public facing) so we probably shouldn't duplicate it? WDYT?
There was a problem hiding this comment.
Agree. If this is just GH facing then I'm fine with that.
| When creating a PR, follow the naming conventions depending on the change being made: | ||
|
|
||
| * New connectors: “🎉 New source or destination: <name>” e.g: `🎉 New Source: Okta` | ||
| * New features: “🎉<Source or Destination> <name>: <feature description> E.g: |
There was a problem hiding this comment.
Add a small note about core features?
Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io>
…byte into sherif/docs-best-practices
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Updates the "updating documentation" section of the docs to add best practices and guidlines for documentation.