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

Remove all end-user documentation from Data Prepper repo #2740

Open
2 tasks
dlvenable opened this issue May 23, 2023 · 0 comments
Open
2 tasks

Remove all end-user documentation from Data Prepper repo #2740

dlvenable opened this issue May 23, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation maintenance Issues to help maintain the project, such as improving builds, testing, etc.

Comments

@dlvenable
Copy link
Member

dlvenable commented May 23, 2023

Currently, Data Prepper has end-user documentation in plugin repos and the docs folder. Much of this information is already in the opensearch.org documentation Git repo and thus is duplicated.

Update all plugin README.md files to have the following structure:

# plugin_name

<Brief introduction>

<Link to the opensearch.org documentation>

## Developer guide

<Any specific instructions for developing within this plugin>

Also, update the end-user documentation in the docs directory to simply redirect users to the opensearch.org documentation.

# Original title

This documentation has moved to <link to the opensearch.org documentation>.

Tasks

  • Collect the plugins that need to be added and put below.

Plugins

  • s3-source

Docs directory

@dlvenable dlvenable added documentation Improvements or additions to documentation maintenance Issues to help maintain the project, such as improving builds, testing, etc. labels May 23, 2023
@dlvenable dlvenable added this to the v2.4 milestone May 23, 2023
@dlvenable dlvenable moved this from Unplanned to To do in Data Prepper Tracking Board Aug 10, 2023
@dlvenable dlvenable modified the milestones: v2.4, v2.5 Aug 10, 2023
@dlvenable dlvenable modified the milestones: v2.5, v2.6, v2.7 Oct 3, 2023
@dlvenable dlvenable modified the milestones: v2.7, v2.8 Jan 30, 2024
@dlvenable dlvenable removed this from the v2.8 milestone Apr 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Issues to help maintain the project, such as improving builds, testing, etc.
Projects
Development

No branches or pull requests

1 participant