Skip to content

[DOCS] Creates custom landing page for the Rust client book #217

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
merged 3 commits into from
Mar 31, 2023

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Mar 30, 2023

Overview

This PR adds a new landing page to the Rust client book so it will be more in line with the main docs landing page, the ES guide landing page, and the Kibana guide landing page.

Screenshot 2023-03-30 at 13 38 26

The content can be easily modified based on feedback.

@szabosteve szabosteve added the documentation Improvements or additions to documentation label Mar 30, 2023
@szabosteve szabosteve requested a review from swallez March 30, 2023 11:35
Copy link
Member

@swallez swallez left a comment

Choose a reason for hiding this comment

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

As stated in the overview page, the full documentation is hosted on docs.rs and we only provide an overview here.

The reason for this is that Rust libraries ("crates") are published on crates.io which builds and publishes the documentation.

It would probably be best to add this text as the first item of the landing page, so that users are informed about it and do not think that there are only these few introductory pages.

WDYT?

@szabosteve
Copy link
Contributor Author

@swallez Sure, it makes sense! I'll modify the description accordingly.

Copy link
Member

@swallez swallez left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

@szabosteve szabosteve merged commit 4b93382 into main Mar 31, 2023
@szabosteve szabosteve deleted the szabosteve/custom-landing-page branch March 31, 2023 13:04
@szabosteve
Copy link
Contributor Author

💚 All backports created successfully

Status Branch Result
8.7

Questions ?

Please refer to the Backport tool documentation

szabosteve added a commit to szabosteve/elasticsearch-rs that referenced this pull request Mar 31, 2023
szabosteve added a commit that referenced this pull request Mar 31, 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.

2 participants