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: Re-write search settings reference #172

Merged
merged 1 commit into from
May 19, 2022

Conversation

NickolausDS
Copy link
Contributor

@NickolausDS NickolausDS commented May 17, 2022

The old docs were difficult to read in list format. The new search
settings references are now in table format for better readability

The main search-indexes.rst doc was removed and replaced with a
'search' centric doc labeld search-settings-reference.rst, which
defines all search-related fields. The facets.rst doc was also
removed and included within this doc, which listed similiar settings.

Screen Shot 2022-05-17 at 3 50 04 PM

The old docs were difficult to read in list format. The new search
settings references are now in table format for better readability

The main `search-indexes.rst` doc was removed and replaced with a
'search' centric doc labeld `search-settings-reference.rst`, which
defines all search-related fields. The `facets.rst` doc was also
removed and included within this doc, which listed similiar settings.
@NickolausDS
Copy link
Contributor Author

@tskluzac, if you're curious, here's the updated doc for the settings ref. It moves items into tables and should make things much more readable.

Copy link
Contributor

@sturoscy-personal sturoscy-personal left a comment

Choose a reason for hiding this comment

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

Nice update. Much more readable.

@NickolausDS
Copy link
Contributor Author

Thanks for taking a look!

@NickolausDS NickolausDS merged commit 2effeee into globus:main May 19, 2022
NickolausDS added a commit to NickolausDS/django-globus-portal-framework that referenced this pull request Sep 15, 2022
MDF Styling and Widget Updates
@NickolausDS NickolausDS deleted the search-settings-reference branch April 3, 2023 18:56
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.

None yet

2 participants