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

Docs: update docs for src validate command to add new install subcommand #46397

Merged
merged 4 commits into from
Jan 13, 2023

Conversation

jdpleiness
Copy link
Contributor

localhost_5080_admin_validation

This is a documentation update for the new install subcommand for src validate that will be introduced in sourcegraph/src-cli#921.

  • Updated examples to reflect new configuration layout
  • Updated references to src validate to be src validate install
  • Made warning that features are experimental more visible

Test plan

Run yarn docsite:serve to stand up documentation.

@jdpleiness jdpleiness requested review from eseliger, mucles and a team January 12, 2023 22:31
@jdpleiness jdpleiness self-assigned this Jan 12, 2023
@cla-bot cla-bot bot added the cla-signed label Jan 12, 2023
@sourcegraph-bot
Copy link
Contributor

Codenotify: Notifying subscribers in CODENOTIFY files for diff 1ef9f8b...e9b1bfa.

Notify File(s)
@sourcegraph/delivery doc/admin/validation.md

Copy link
Contributor

@abeatrix abeatrix left a comment

Choose a reason for hiding this comment

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

LGTM 🔥

@@ -1,21 +1,22 @@
# Sourcegraph Instance Validation

>NOTE: **Sourcegraph Instance Validation is currently experimental.** We're exploring this feature set.
>🚨 WARNING 🚨: **Sourcegraph Instance Validation is currently experimental.** We're exploring this feature set.
Copy link
Contributor

Choose a reason for hiding this comment

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

We should use emoji more 😆

@abeatrix
Copy link
Contributor

What do you think about adding those nice code snippet to the docs as examples 😏? I also like how clean it currently is though 🥴

@jdpleiness
Copy link
Contributor Author

I am going back and forth on that too. I think for now leave it as is, then we can always add more later.

@jdpleiness jdpleiness merged commit 3aa88f1 into main Jan 13, 2023
@jdpleiness jdpleiness deleted the jdp/src-validate-docs branch January 13, 2023 18:19
@github-actions
Copy link
Contributor

Problem: the label i-acknowledge-this-goes-into-the-release is absent.
👉 What to do: we're in the next Sourcegraph release code freeze period. If you are 100% sure your changes should get released or provide no risk to the release, add the label your PR with i-acknowledge-this-goes-into-the-release.

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