Add the pipeline subdocument to the Sources document
#8211
Conversation
linghengqian
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
There was a problem hiding this comment.
Thank you @linghengqian for this contribution!
@kolchfa-aws , Does this look good from you perspective? If so, I'd like to get this in. This functionality is applicable for all versions of Data Prepper.
There was a problem hiding this comment.
Thank you, @linghengqian! Just a couple of fixes. I've added a suggestion to fix the topic order as part of this PR but please feel free to put in an issue instead. Thanks!
| title: pipeline | ||
| parent: Sources | ||
| grand_parent: Pipelines | ||
| nav_order: 55 |
There was a problem hiding this comment.
The topic names under "Sources" are not alphabetized. Could you fix that as part of this PR? Use Pascal numbering (multiples of 10).
There was a problem hiding this comment.
- I don't seem to see any directories following the so-called
Pascal numbering (multiples of 10). I made a new commit, should it look like this?
| @@ -0,0 +1,30 @@ | |||
| --- | |||
There was a problem hiding this comment.
The configuration directory seems unnecessary. Just want to flag this for a future fix. This just makes the link longer (and shorter links are preferable for SEO). We can fix that by removing the configuration folder and adding redirects from the old link to the new link in all files under the pipelines directory. @vagimeli Could you please put in an issue to fix this?
| source: | ||
| - pipeline: | ||
| name: "movies" | ||
| ``` |
There was a problem hiding this comment.
| ``` | |
| ``` | |
| {% include copy.html %} |
There was a problem hiding this comment.
Looking at the Data Prepper section, none of the yaml snippets have the yaml highlighter or copy button added. @vagimeli Could you please put in an issue to fix this?
Signed-off-by: linghengqian <[email protected]>
linghengqian
force-pushed
the
new-doc
branch
from
dbc0d32 to
c423f4d
Compare
There was a problem hiding this comment.
Thank you, @linghengqian! Moving the PR into editorial review. Once it's done, we'll be ready to merge.
Signed-off-by: linghengqian <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> (cherry picked from commit 8ba63fe) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
…project#8211) Signed-off-by: linghengqian <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Signed-off-by: Noah Staveley <[email protected]>
Description
Describe what this change achieves.
pipelinesubdocument to theSourcesdocument.Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
Sourcesdocumentation should addpipelinesubdocumentation data-prepper#4922 .Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.