Summary: It is only used by the website SVG renderer. Let's make it optional.
Reviewed By: muirdm
Differential Revision: D42590209
fbshipit-source-id: 17231e8468792dfb87cc2010d4b74257fb5257b6
Summary:
This removes the `ps>` prefix in the windows installation instructions. With `ps>` included, you can't directly copy and past the commands into powershell
Pull Request resolved: https://github.com/facebook/sapling/pull/454
Reviewed By: evangrayk
Differential Revision: D42594922
Pulled By: bolinfest
fbshipit-source-id: f798d9d74fdccfd088be9efb869857cfee8dead4
Summary:
I recently built and installed Sapling on a Windows machine
with few existing developer tools installed on it, so I wanted
to capture the `vcpkg` requirements that were not previously
documented.
Reviewed By: akushner
Differential Revision: D42232827
fbshipit-source-id: e6c9ce74b164b8f552188946a032852e06d03ec7
Summary:
Using the fix in D42230099, regenerate the command docs
for the website.
Pull Request resolved: https://github.com/facebook/sapling/pull/351
Test Plan:
Imported from OSS
Verify that `yarn build` works with the current `.md` file contents.
Reviewed By: zzl0
Differential Revision: D42230100
Pulled By: bolinfest
fbshipit-source-id: b9929bc1fdd4ede3dc032fdc310c4ca10e4a9194
Summary:
We currently have an issue where the generated docs for
`sl pr` produce a line that happens to start with the word `import`.
MDX tries to parse this line as an import statement.
As a quick fix so we can publish the website again,
introduce a simple escaping solution as described on:
https://stackoverflow.com/questions/61188612/escaping-import-and-react-html-to-display-as-text-in-mdx/74096776
Pull Request resolved: https://github.com/facebook/sapling/pull/352
Test Plan:
Imported from OSS
Verified in D42230100
Reviewed By: zzl0
Differential Revision: D42230099
Pulled By: bolinfest
fbshipit-source-id: af2f87e40ed7d71dac5eba7a054f026a1209ec62
Summary:
Note this fixes a broken link due to the `<Command>` change.
Fixes https://github.com/facebook/sapling/issues/335
Reviewed By: muirdm
Differential Revision: D42121142
fbshipit-source-id: 5a06757f1cc73c2b01cc9ddae1ed29bb9c9ea056
Summary:
- Use production config to pick up color and template definitions.
- Ensure `sl` command (shell function) is available.
- Specify a better-than-default colors.
Reviewed By: muirdm
Differential Revision: D42102950
fbshipit-source-id: 7ceef74f515ebb836c8b59af698cfa9794e046b4
Summary:
As we are going to add more flags for `sl pr submit`, it no longer
works well to use `submit` as the default command. Though we
add `s` as an alias for `submit` so it does not require much typing.
Reviewed By: zzl0
Differential Revision: D42047829
fbshipit-source-id: 782339a44ec5b548b6fc5e61a32f8fb05c0c8fe4
Summary: Adds installation instructions for installing from Homebrew-core on macOS so that users don't have to manually download our bottle. It also adds one additional installation method for non-Ubuntu Linux users.
Reviewed By: bolinfest
Differential Revision: D42008426
fbshipit-source-id: 76757f43739bca3133e3265d5bbe6175edbc9f11
Summary:
This was requested for `sl pr` in
https://github.com/facebook/sapling/issues/218,
though this diff adds support for signing commits in general, in Sapling.
Here's how it works:
- `sl config --local gpg.key <KEY>` to specify your key
- Now `gitcommittext()` takes an optional `str` for the `gpgsigningkey` if `gpg.key` is set and `gpg.enabled` is `true` (which is the default).
- The text of the unsigned commit object is constructed and then signed using `gpg --status-fd=2 -bsau <KEY>` with the text passed via stdin.
- The resulting signature is embedded into the original text to sign it. Note that the original PGP key goes through some minor formatting (`\r` is removed; lines must start with a space to avoid a `\n\n` sequence) before it is embedded.
I documented things to the best of my knowledge in `eden/website/docs/git/signing.md`.
Follow-up items:
- Show signed status in smartlog?
- Update `sl ghstack` to honor signing configuration when running `git commit-tree`.
- Update `sl pr` to honor signing configuration when running `git commit-tree`.
Reviewed By: quark-zju
Differential Revision: D41778874
fbshipit-source-id: 5018a0d8bea1b5e9293c05954db65f35dd3c7aff
Summary:
When a user installs/browses the Sapling extension for VS Code,
they are presented with the `README.md`. Because this is likely
the user's entrypoint into the extension, this updates the README
with more guidance (and links) on how to get into the ISL experience.
Reviewed By: muirdm
Differential Revision: D41814194
fbshipit-source-id: 5c24d5e45655bde5db6287d1508e906b1c81e847
Summary:
Updates:
- `loader-utils` 3.2.0 -> 3.2.1
- `react-scripts` 5.0.0 -> 5.0.1
Unfortunately, `yarn audit` still lists a bunch of stuff under
both `website/` and `addons/`, but it's tricky for us to fix
some of the downstream items, such as the use of
`nth-check@1.0.2`:
```
┌───────────────┬──────────────────────────────────────────────────────────────┐
│ high │ Inefficient Regular Expression Complexity in nth-check │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Package │ nth-check │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Patched in │ >=2.0.1 │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Dependency of │ isl │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ Path │ isl > react-scripts > svgr/webpack > svgr/plugin-svgo > │
│ │ svgo > css-select > nth-check │
├───────────────┼──────────────────────────────────────────────────────────────┤
│ More info │ https://www.npmjs.com/advisories/1070415 │
└───────────────┴──────────────────────────────────────────────────────────────┘
```
Reviewed By: sggutier
Differential Revision: D41754723
fbshipit-source-id: 92e23d56ae28298397b98a1dd7b06c6ff063a5a8
Summary:
Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/facebook/sapling/pull/294).
* __->__ https://github.com/facebook/sapling/issues/294
add Troubleshooting section for GitHub page
I just ran into an issue where `sl pr` failed to run because I
did not have `gh` configured as my Git credential helper.
It took me a bit of time to figure this out, so I thought I would
add it to the website, though the docs related to GitHub
integration are somewhat spread out, so I'm not sure whether this
is the best place for it. A dedicated Troubleshooting page might
be more appropriate, though such a page should probably have at
least two entries?
Though perhaps an even better solution is updating the code to
recognize this sort of failure and then suggest `gh auth setup-git`
directly when it happens.
Pull Request resolved: https://github.com/facebook/sapling/pull/294
Test Plan: http://localhost:3000/docs/git/intro
Reviewed By: akushner
Differential Revision: D41663482
Pulled By: bolinfest
fbshipit-source-id: ff957e298c143c62a2c05ea231eca8431011d106
Summary:
Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/facebook/sapling/pull/264).
* __->__ https://github.com/facebook/sapling/issues/264
[docs] add sl-shell-example syntax-highlighting language
Right now the example sl sessions have no hightlighting, or sometimes they pretend to be bash, which kind-of-half-works but also half doesn't work and is ugly (See the "Before" example - there is random highlighting for some numbers in the middle of command output, the ".." in "..." is randomly highlighted as a directory, etc)
This diff adds a new custom Prism language called "sl-shell-example" which does syntax highlighting specifically tailored for our example sessions with these main parts:
```
# comment
$ shell command
~/my/subdir $ shell command in a specific subdirectory
output
```
{F806536674}
(For the record, Prism already has a language called "shell-session", but that language doesn't support comments (which is something we make heavy use of), and also it tries to be clever by highlighting random words in the middle of shell commands (which is just distracting in the context of sapling docs))
Pull Request resolved: https://github.com/facebook/sapling/pull/264
Test Plan:
Before:
{F806536931}
After:
{F806537002}
Reviewed By: quark-zju
Differential Revision: D41522986
Pulled By: shish
fbshipit-source-id: fda9beb423a3c74d90c4cb387eb8cba3914a4693
Summary: Ran `./scripts/gen_release_data.py` to create this change.
Reviewed By: sggutier
Differential Revision: D41664247
fbshipit-source-id: beca259205880f16642a357a7a8bd7c22cfd94c4
Summary:
When using the dark theme the contrast of the Get Started button is not very good.
This diff sets the font color of Get Started to be black the whole time like how it is in the light theme. Currently in the dark theme the font color is white by default and turns black when hovered over.
Reviewed By: MichaelCuevas
Differential Revision: D41432365
fbshipit-source-id: 03fe09a1a151e74c9e86d2b133b863ff2a845ab9
Summary:
Get the windowsAsset version in the docs.
Pull Request resolved: https://github.com/facebook/sapling/pull/237
Reviewed By: bolinfest, zzl0
Differential Revision: D41476635
Pulled By: MichaelCuevas
fbshipit-source-id: 3769923de939a46b956bc7949a90af75a5989f0f
Summary:
Pull Request resolved: https://github.com/facebook/sapling/pull/242
Ran `./scripts/gen_release_data.py` and verified
`rawReleaseData.ts` had the expected values.
Test Plan:
Ran the script and verified the `name`
field was included in the generated JSON.
Reviewed By: MichaelCuevas
Differential Revision: D41452965
Pulled By: bolinfest
fbshipit-source-id: c178bc6ad8ba572872a6f88b87f45e3b141bffab
Summary: Pull Request resolved: https://github.com/facebook/sapling/pull/241
Test Plan:
Ran the script with no args and verified that
the desired file was updated with the right info.
Reviewed By: muirdm
Differential Revision: D41452878
Pulled By: bolinfest
fbshipit-source-id: 296f8f0239f0de00ce14510d61a08870fa94eafe
Summary:
Minor adjustments:
- Fixes mistakes I made in those docs.
- Fix/add links.
- Clarify some differences with hg.
Reviewed By: muirdm
Differential Revision: D41393733
fbshipit-source-id: 726ee783723d0fa5b4c60376487ed93de3a520ab
Summary:
The original docs were a bit sparse and I don't think
I was clear enough on the distinction between
"stock ghstack" and `sl ghstack`. Hopefully this clears
things up.
Reviewed By: evangrayk
Differential Revision: D41382719
fbshipit-source-id: 0b3aadf5a8615b0571be1a07db5d8d33099d1308
