Skip to content

Conversation

@leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Jul 31, 2023

ℹ️ Don't worry about the files changed number, it's ~90% renaming 😄

  • Updates/adds READMEs to all main sections:
    • main README
    • example-apps
    • notebooks
  • Renames/consolidates example apps
  • Copyedits existing instructions

Probably didn't catch everything here, but can circle back for smaller, targeted updates.

@leemthompo leemthompo added the documentation Improvements or additions to documentation label Jul 31, 2023
@leemthompo leemthompo self-assigned this Jul 31, 2023
Copy link

@chriscressman chriscressman left a comment

Choose a reason for hiding this comment

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

I took a look at all the READMEs. Looks like a good round of general cleanup to me 😄

May want to rename some of the example app directories to give them more generic names that describe the type of app or use case. The notebook directories are a good example of this.

- [ChatGPT and Elasticsearch: A plugin to use ChatGPT with your Elastic data](https://www.elastic.co/blog/chatgpt-elasticsearch-plugin-elastic-data)


> ℹ️ **Note**:

Choose a reason for hiding this comment

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

This looks like something we'd want to include for all READMEs or move up higher in the hierarchy to cover everything?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

move up higher in the hierarchy to cover everything?

🎯

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added to follow-up PR

Choose a reason for hiding this comment

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

We could clarify how our two docs GPT example apps relate. This one is for those who want to use the ChatGPT UI, while the other is for those who want to use the GPT API with their own UI.

Copy link
Contributor Author

@leemthompo leemthompo Aug 1, 2023

Choose a reason for hiding this comment

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

Good point, I can clarify this in the individual readmes and the overall example-apps readme.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added to follow-up PR

Copy link
Member

@joemcelroy joemcelroy left a comment

Choose a reason for hiding this comment

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

looks great! could you rebase?

@leemthompo leemthompo merged commit 2f9618b into elastic:main Aug 1, 2023
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

None yet

Development

Successfully merging this pull request may close these issues.

3 participants