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: make information on skipping/cancelling builds more discoverable #11274

Open
agjohnson opened this issue Apr 12, 2024 · 0 comments
Open
Labels
Improvement Minor improvement to code

Comments

@agjohnson
Copy link
Contributor

agjohnson commented Apr 12, 2024

While linking a user to our docs on skipping builds, I found a gap in our search. I think the issue is mostly terminology though. In documentation we call this cancelling but in the application we refer to this as both skipped and cancelled:

https://beta.readthedocs.org/projects/test-builds/builds/23877501/

image

But, the content I was looking for was:

I used the search query skip and had no relevant hits. The queries skip build and skipping build do give the above results back in 3rd and 4th position. The query cancel has direct hits.

Perhaps we need to consolidate terminology in the application/docs here. I think we might be able to just add some hits for skip to our content too, so both queries have hits.

The user here had similar trouble finding this information and was looking on our configuration reference page:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

1 participant