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

Suggestions for the transcoding docs #3837

Merged

Conversation

AhdraMeraliQB
Copy link
Contributor

@AhdraMeraliQB AhdraMeraliQB commented Apr 24, 2024

Description

Was leaving suggestions in my review of #3833 and it got a little out of hand 😅

Main aims with these changes:

  • Give the example nodes names for easier reference, and to be consistent with our recommendations for best practice (this is unfortunately inconsistent across our documentation)
  • De-technical-ify the explanations as much as possible
  • Renamed the subsection to fit the format of the rest of the DataCatalog examples
  • Break up the subsection into more subsubheadings for easier navigation, and because the sidebar seemed to imply only incorrect examples were included:
    Screenshot 2024-04-24 at 14 47 28

Development notes

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Ahdra Merali added 3 commits April 24, 2024 17:02
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Copy link
Contributor

@ElenaKhaustova ElenaKhaustova left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@ElenaKhaustova ElenaKhaustova merged commit f89e4f9 into docs/3676-transcoding-dataset Apr 24, 2024
4 checks passed
@ElenaKhaustova ElenaKhaustova deleted the ahdra/transcoding-suggestions branch April 24, 2024 21:46
ElenaKhaustova added a commit that referenced this pull request Apr 29, 2024
* Updated section name

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Added incorrect use of transcoding section

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Added a clarification on how trancoding is used

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Added examples explanation

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Updated section reference

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Applied suggested change of section name

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Rephrased wordings to avoid github warnings

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Updated section reference

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Suggestions for the transcoding docs (#3837)

* Suggestions

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Apply suggestions from review

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Fix broken internal link

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Appease Vale (as much as possible)

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

---------

Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>

* Added missing quotes

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Applied suggested changes

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Added admonition

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

* Fixed typo

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>

---------

Signed-off-by: Elena Khaustova <ymax70rus@gmail.com>
Signed-off-by: Ahdra Merali <ahdra.merali@quantumblack.com>
Co-authored-by: Ahdra Merali <90615669+AhdraMeraliQB@users.noreply.github.com>
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.

2 participants