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

docs: add developers-landing page to sidebars #17780

Merged
merged 1 commit into from
Sep 27, 2022

Conversation

tisonkun
Copy link
Member

This is a followup to #17284.

cc @DaveDuggins @Anonymitaet @momo-jun @urfreespace

Documentation

  • doc-required
    (Your PR needs to update docs and you will update later)

  • doc-not-needed
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

Matching PR in forked repository

docs only change

@tisonkun
Copy link
Member Author

Currently, this page is dangling:

image

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Sep 21, 2022
@DaveDuggins
Copy link
Contributor

Hi tison! This page does not require sidebar links. The landing pages I'll be creating PRs for over the next few days will not require a sidebar link. These pages serve only as a connection point between the content blocks on the main documentation page and the topics. No additional navigation is needed.

@tisonkun
Copy link
Member Author

@DaveDuggins this patch doesn't add a new entry but reuse the "development" entry.

If we don't add it to the sidebars, how can users find the page? Only by entering the exact url? It seems unreasonable.

@tisonkun
Copy link
Member Author

@DaveDuggins OK. I see the link from the original patch. Let me show you the result of this patch in preview later today.

@tisonkun
Copy link
Member Author

cc @DaveDuggins

Current:

Screen.Recording.2022-09-22.at.09.24.43.mov

Preview with this patch:

Screen.Recording.2022-09-22.at.09.26.32.mov

@tisonkun
Copy link
Member Author

ping @DaveDuggins @Anonymitaet @momo-jun @urfreespace for another turn.

@DaveDuggins
Copy link
Contributor

@DaveDuggins this patch doesn't add a new entry but reuse the "development" entry.

If we don't add it to the sidebars, how can users find the page? Only by entering the exact url? It seems unreasonable.

No, by clicking the appropriate topic box on the main documentation page. These landing pages only serve as a bridge to the related articles linked from the content blocks on the main doc page.

@tisonkun
Copy link
Member Author

tisonkun commented Sep 23, 2022

@DaveDuggins Yep. Please read the following comment for preview. This change won't break existing things and as an improvement.

@tisonkun
Copy link
Member Author

@DaveDuggins @momo-jun @urfreespace @Anonymitaet shall we merge this patch now?

@momo-jun momo-jun merged commit 91f747f into apache:master Sep 27, 2022
@tisonkun tisonkun deleted the add-dev-landing-to-sidebars branch September 27, 2022 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants