Skip to content

Removelearn/configuration/settings.md #2044

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 11 commits into from
Dec 22, 2022

Conversation

maryamsulemani97
Copy link
Contributor

@maryamsulemani97 maryamsulemani97 commented Dec 13, 2022

closes #1614

Update

  • We decided to go with 3

What is this PR doing?

  • Removes all unused code samples
  • Updates links from /learn/configuration/settings.md to API reference
  • Uses the same table in the API reference and /learn/configuration/settings.md
  • Adds "developer-friendly syntax" to the "Body" of each setting in the API reference
    - Moves "developer-friendly syntax"(displayedAttributes=[<String>, <String>, ...]) to a new column "Format" in the table in /learn/configuration/settings.md
    - I don't like how the table looks because of the "Format" column, and "Type" and "Format" are talking about the same thing:
    - Should we remove "Type"? I think it's a lot easier to process compared to "Format"
    - Orrr we could have the same table as the API reference? It will be easier to update too. Update one table and copy it to the other
    WDYT @guimachiavelli @dichotommy?

  1. We get rid of /learn/configuration/settings.md

Screen Shot 2022-12-13 at 15 46 40

  • The guides seem to pop out of nowhere. We could rename the "Index settings" heading to something more suitable.
  1. Only keep /learn/configuration/instance_options.md under Configuration. Move the guides to "Advanced topics"

Screen Shot 2022-12-13 at 15 54 12

  • The guides are very different from the current content under "Advanced topics". Should we create a new heading?
  • Makes it look like there isn't any content under "Configuration"
  1. We only keep the "Index settings" table in /learn/configuration/settings.md
  • The reader will get a summary of the different settings without having to go to another page, and we can keep the guides here

Copy link
Contributor

@dichotommy dichotommy left a comment

Choose a reason for hiding this comment

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

I really like the addition of the developer-friendly syntax to the settings API reference. I think it adds a lot in terms of drawing the reader's eye.

@maryamsulemani97 maryamsulemani97 removed their assignment Dec 20, 2022
Copy link
Contributor

@dichotommy dichotommy left a comment

Choose a reason for hiding this comment

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

🧘🏻

@dichotommy dichotommy removed their assignment Dec 22, 2022
@maryamsulemani97
Copy link
Contributor Author

bors merge

@bors
Copy link
Contributor

bors bot commented Dec 22, 2022

@bors bors bot merged commit deb4fe5 into main Dec 22, 2022
@bors bors bot deleted the Remove/simplify-learn/configuration/settings.md branch December 22, 2022 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove/simplify learn/configuration/settings.md
2 participants