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

[FEATURE] Improve the process of publishing doc changes to documentation repo #1021

Open
dai-chen opened this issue Nov 3, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@dai-chen
Copy link
Collaborator

dai-chen commented Nov 3, 2022

Is your feature request related to a problem?
Currently, there are 2 places for both SQL/PPL documentation: doc/ folder in SQL repo and https://github.com/opensearch-project/documentation-website. Before every release, we have to post another PR in doc repo manually like this: opensearch-project/documentation-website#830

What solution would you like?
One possible solution is to embed our RST doc to documentation website. Then we can get tech writer review it in each PR with doc changes. For new doc, they can review it when we post PR with embedded link to doc repo. This may lead to webpage style or other problem, however, we should start thinking about how to improve this anyway.

What alternatives have you considered?
Automate the process to convert RST doc to markdown and send PR to doc repo with little manual work. But this still requires to maintain two copies of documentation. Any comment on the PR in doc repo has to be merged back to our repo. Unless we can get tech writer involved in each our PR for early review.

Do you have any additional context?
N/A

@dai-chen dai-chen added the documentation Improvements or additions to documentation label Nov 3, 2022
@github-project-automation github-project-automation bot moved this to Planned work items in Test roadmap format Apr 19, 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
Projects
Status: Planned work items
Development

No branches or pull requests

1 participant