search

sourcegraph / src-cli

Sourcegraph CLI
https://sourcegraph.com
Apache License 2.0
267 stars 57 forks source link

fix(Source): Fix broken code host doc links #1096

Closed mmanela closed 2 weeks ago

mmanela commented 3 weeks ago

Fixes urls to doc pages that do not resolve anymore

Test plan

mmanela commented 3 weeks ago

@jhchabran After this is fixed we need to get sourcegraph repo to use it so we can re-generate doc/cli/references/serve-git.md. Can you point me to how I do that?

jhchabran commented 2 weeks ago

@mmanela

  1. Need to cut a new release in src-cli
  2. Update SRC_CLI_VERSION
  3. Run sg bazel //doc/cli/references:write_doc_files (the classic approach is to use //dev:write_all_generated but I gave you the specific target that does it so it's faster).
    • It will fail on the first run, complaining about a different checksum for the archive, take the new one and update it in the same file.
    • On the second run it will update the docs.
  4. Commit and open a PR.
  5. Once it lands on main, it will automatically generates a PR toward the docs repo.