Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Repo cleanup: consolidate/rename folders, add/update READMEs #8

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

Merged
leemthompo merged 4 commits into elastic:main from leemthompo:repo-docs-updates
Aug 1, 2023

Conversation

@leemthompo
Copy link
Contributor

@leemthompo leemthompo commented Jul 31, 2023
edited
Loading

i️ 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)


> i️ **Note**:
Copy link

@chriscressman chriscressman Jul 31, 2023

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

@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.

move up higher in the hierarchy to cover everything?

🎯

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.

Added to follow-up PR

Copy link

@chriscressman chriscressman Jul 31, 2023

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
edited
Loading

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

@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.

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joemcelroy joemcelroy joemcelroy approved these changes

+1 more reviewer

@chriscressman chriscressman chriscressman left review comments

Reviewers whose approvals may not affect merge requirements

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /