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

🚚 Prefer the Term Preferences to Configuration #166

Merged
merged 2 commits into from
Apr 26, 2024

Conversation

gilday
Copy link
Contributor

@gilday gilday commented Apr 25, 2024

When describing the mechanism by which the user tailors Pixeebot to their preferences, we want to use the term "preferences" instead of "config". Preferences implies that making changes is optional: Pixeebot still works out-of-the-box without requiring users to configure it. On the other hand, configuration is typically associated with a required step in the process of beginning to use a tool.

/close #work

@gilday
Copy link
Contributor Author

gilday commented Apr 25, 2024

I kept the URI path to the preferences page as https://docs.pixee.ai/configuring/, because I'm unsure the server that hosts our docs has the capability to redirect pages.

@gilday
Copy link
Contributor Author

gilday commented Apr 25, 2024

I stacked this change behind branch iss-855/prepend-exclude-codemod-preferences, because that change adds more to the configuring.md page, and I didn't want to get into a situation where I merge this change first and forget to use the term preferences in that outstanding PR.

@gilday gilday marked this pull request as ready for review April 25, 2024 00:51
@gilday gilday requested review from terranosaurus and sip49 April 25, 2024 00:51
Copy link
Member

@sip49 sip49 left a comment

Choose a reason for hiding this comment

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

lgtm

@gilday gilday force-pushed the iss-855/prepend-exclude-codemod-preferences branch from 42e5d79 to be6bcdc Compare April 26, 2024 14:30
docs/configuring.md Outdated Show resolved Hide resolved
docs/configuring.md Outdated Show resolved Hide resolved
docs/configuring.md Outdated Show resolved Hide resolved
Base automatically changed from iss-855/prepend-exclude-codemod-preferences to main April 26, 2024 16:36
gilday added 2 commits April 26, 2024 12:37
When describing the mechanism by which the user tailors Pixeebot to
their preferences, we want to use the term "preferences" instead of
"config". Preferences implies that making changes is optional: Pixeebot
still works out-of-the-box without requiring users to configure it. On
the other hand, configuration is typically associated with a required
step in the process of beginning to use a tool.

/close #work
@gilday gilday force-pushed the iss-700/rename-config-to-preferences branch from 791fa6f to 242d5dc Compare April 26, 2024 16:37
@gilday gilday merged commit 9f0827b into main Apr 26, 2024
3 checks passed
@gilday gilday deleted the iss-700/rename-config-to-preferences branch April 26, 2024 17:15
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.

3 participants