Skip to content
This repository was archived by the owner on Sep 30, 2024. It is now read-only.

Search: clarify wording for indexing job progress#57903

Merged
jtibshirani merged 1 commit into
mainfrom
jtibs/index-job
Oct 26, 2023
Merged

Search: clarify wording for indexing job progress#57903
jtibshirani merged 1 commit into
mainfrom
jtibs/index-job

Conversation

@jtibshirani

Copy link
Copy Markdown
Contributor

During a recent support issue, some engineers were confused by the wording, and thought the commit SHA and skipped files related to the in-progress indexing job. In reality, they are describing the last successful job run. This change tries to clarify the wording a bit.

Test plan

Visual inspection.

Before (screenshot from customer instance):

Screenshot 2023-10-25 at 3 44 38 PM

After (from local testing):

Screenshot 2023-10-25 at 3 39 11 PM

If an index job is running it will say "indexing in progress" instead of "up to date".

@cla-bot cla-bot Bot added the cla-signed label Oct 25, 2023
@jtibshirani jtibshirani requested review from a team and mike-r-mclaughlin October 25, 2023 22:52
<Code weight="bold">{indexedRef.ref.displayName}</Code>
</LinkOrSpan>{' '}
</LinkOrSpan>
&nbsp;&mdash;&nbsp;

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm not clear on our use of &nbsp versus {' '}, any feedback welcome here!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

&nbsp is a non-breaking space and {' '} puts a space between two JSX elements. Depends on what you want :) I think &nbsp makes sense here, but there's also no super hard requirement, I think.

@jtibshirani jtibshirani marked this pull request as ready for review October 25, 2023 22:53
@sourcegraph-bot

Copy link
Copy Markdown
Contributor

📖 Storybook live preview

@jtibshirani jtibshirani merged commit 87eaed5 into main Oct 26, 2023
@jtibshirani jtibshirani deleted the jtibs/index-job branch October 26, 2023 14:57
jtibshirani added a commit that referenced this pull request Dec 8, 2023
During a recent support issue, some engineers were confused by the wording, and thought the commit SHA and skipped files related to the in-progress indexing job. In reality, they are describing the last successful job run. This change tries to clarify the wording a bit.
keegancsmith pushed a commit that referenced this pull request Dec 11, 2023
* Admin: add search indexing to repo menu (#58061)

When debugging a search issue, it's common to want to check the status of
search indexing. Currently, you need to open the repo menu and click through to
'Settings' -> 'Search Indexing', which is not obvious. This change adds 'Search
indexing' directly to the repo menu, matching what we do for 'Permissions' and
'Last sync log'.

To counterbalance this, this change also removes the 'Embeddings Jobs' item. It
felt cluttered to have two 'Embeddings' items, and we want to direct people
towards policies instead of manually scheduling jobs.

* Admin: improve search indexing icon (#58415)

In #58061 we added 'Search indexing' to the repo dropdown menu, in place of
having two Embeddings items. However, I forgot to update the icon, so it was
using the old Embeddings icon.

* Search: clarify wording for indexing job progress (#57903)

During a recent support issue, some engineers were confused by the wording, and thought the commit SHA and skipped files related to the in-progress indexing job. In reality, they are describing the last successful job run. This change tries to clarify the wording a bit.

* Admin: avoid false impression that Zoekt is indexing (#58793)

Previously, when an index is not up-to-date, we'd always claim that we're
actively indexing the repo. This is misleading, because indexing indexing could
be stuck or failing.

Now, we remove the loading spinner and just say the repo is "queued for
indexing". If the index is out-of-date and it's been more than 8 hours since
the last successful job, then we also show a warning tooltip.
vovakulikov pushed a commit that referenced this pull request Dec 12, 2023
During a recent support issue, some engineers were confused by the wording, and thought the commit SHA and skipped files related to the in-progress indexing job. In reality, they are describing the last successful job run. This change tries to clarify the wording a bit.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants