[Docs] Creates Developer docs GH page code #5977
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
ashwin-pc
requested review from
ananzh,
kavilla,
AMoo-Miki,
joshuarrrr,
abbyhu2000,
zengyan-amazon,
kristenTian,
zhongnansu,
manasvinibs,
ZilongX,
Flyingliuhub,
BSFishy,
curq,
bandinib-amzn and
SuZhou-Joe
as code owners
ashwin-pc
changed the title
ashwin-pc
changed the title
SuZhou-Joe
reviewed
Feb 28, 2024
SuZhou-Joe
reviewed
Feb 28, 2024
Comment on lines
+150
to
+153
| - [Opensearch dashboards.release notes 2.10.0](../release-notes/opensearch-dashboards.release-notes-2.10.0.md) | ||
| - [Opensearch dashboards.release notes 2.11.0](../release-notes/opensearch-dashboards.release-notes-2.11.0.md) | ||
| - [Opensearch dashboards.release notes 2.11.1](../release-notes/opensearch-dashboards.release-notes-2.11.1.md) | ||
| - [Opensearch dashboards.release notes 2.12.0](../release-notes/opensearch-dashboards.release-notes-2.12.0.md) |
There was a problem hiding this comment.
A little bit weird about the order here.
There was a problem hiding this comment.
Dont quite know what you mean by the order here. This is simply the folder structure of the OSD repository. What did you expect here?
There was a problem hiding this comment.
Should be the orders that 2.1.0 -> 2.9.0 and then 2.10.0 I suppose, but for now the order is 2.1.0 -> 2.10.0 -> 2.12.0 -> 2.2.0, not a semantic version order.
There was a problem hiding this comment.
Ah i see what you mean. Yeah this currently pulls the files as they appear in the filesystem. I could reorder this but I personally liked how they map 1:1 with the file tree :)
SuZhou-Joe
reviewed
Feb 28, 2024
Comment on lines
+134
to
+137
| - [Opensearch dashboards.release notes 1.3.10](../release-notes/opensearch-dashboards.release-notes-1.3.10.md) | ||
| - [Opensearch dashboards.release notes 1.3.11](../release-notes/opensearch-dashboards.release-notes-1.3.11.md) | ||
| - [Opensearch dashboards.release notes 1.3.12](../release-notes/opensearch-dashboards.release-notes-1.3.12.md) | ||
| - [Opensearch dashboards.release notes 1.3.13](../release-notes/opensearch-dashboards.release-notes-1.3.13.md) |
There was a problem hiding this comment.
Nit: order need to adjust I suppose
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Create CNAME Delete CNAME disable jekyll Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> change to relative path Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> add docs readme Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Adds changelog Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com>
SuZhou-Joe
approved these changes
Mar 1, 2024
kavilla
approved these changes
Mar 11, 2024
|
good stuff! |
7 tasks
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Sep 13, 2024
* Working Dev docs Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Create CNAME Delete CNAME disable jekyll Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> change to relative path Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> add docs readme Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Adds changelog Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> * removes unnecessary debugger Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> --------- Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> (cherry picked from commit 3aa0e5a) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
ashwin-pc
pushed a commit
that referenced
this pull request
Sep 13, 2024
* Working Dev docs Create CNAME Delete CNAME disable jekyll change to relative path add docs readme Adds changelog * removes unnecessary debugger --------- (cherry picked from commit 3aa0e5a) Signed-off-by: Ashwin P Chandran <ashwinpc@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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.
Description
Uses Docsify to generate documentation liks that expose Readme's within the OSD repo as HTML.
The GH Pages running on my local fork: https://ashwin-pc.github.io/OpenSearch-Dashboards/docs/index.html#/
Issues Resolved
Screenshot
Testing the changes
Check List
yarn test:jestyarn test:jest_integration