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: 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:
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:
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:
We're still using old name for goto command in docs.
Closes: #168
Reviewed By: bolinfest, zzl0
Differential Revision: D41342092
fbshipit-source-id: dd883b7c31e7834f2cfaf7afd5938ea3c61c2389
Summary:
Mention how to push to a branch, add a remote, and pull from a non-default
remote. Correct inaccurate git commands in clone/push/pull section.
Change "Foo Bar" to "Foo bar" based on style guide.
Reviewed By: DurhamG
Differential Revision: D41310894
fbshipit-source-id: 977f96b66499fd7d1a125d41a81a9d5e264a5cd9
Summary:
Per style guide [1].
Ran script in docs/ except for docs/commands/:
import glob
import re
capwords = set("ReviewStack Code ISL Watchman Git Sapling GitHub Mercurial Apple Intel Windows EdenFS I Python Unicode".split())
for path in glob.glob('**/*.md', recursive=True):
with open(path, 'rb') as f:
content = f.read().decode()
newlines = []
skip = False
for line in content.splitlines():
if line.startswith('```'):
skip = not skip
if line.startswith('#') and not skip:
words = line.split(' ')
newwords = words[:2]
for word in words[2:]:
if re.sub('[.()]', '', word) not in capwords and word[1:] == word[1:].lower() and not newwords[-1].endswith("."):
# change to lowercase
word = word[:1].lower() + word[1:]
newwords.append(word)
line = ' '.join(newwords)
newlines.append(line)
newcontent = '\n'.join(newlines) + "\n"
if newcontent != content:
print(f'editing {path}')
with open(path, 'wb') as f:
f.write(newcontent.encode())
Manually updated two places using `A/B` like `Files/Trees` in scale/axes.
[1]: https://developers.google.com/style/headings
Reviewed By: sggutier
Differential Revision: D41312633
fbshipit-source-id: 9b45df8b120765d1875c3782e6f9d6e5ddb97af0
Summary: Fix a few typos and reword a few sections to make them flow better.
Reviewed By: akushner
Differential Revision: D41294506
fbshipit-source-id: eeabfb357de23aef896445f4a1056c0e10618c7b
Summary: The default limit on my macbook air is 256 - that's not enough for clones of larger repos to work.
Reviewed By: DurhamG
Differential Revision: D41308172
fbshipit-source-id: 27972c9f8d66d5236b69f5e65f66eb2e472f52b3
Summary:
Changes:
- specify `--output` when using `curl`
- separate commands into separate blocks and drop `$` for easier copy-and-paste
- add `./` in front of filename so brew knows right away that it is a file and not a formula name
Also updated the release info:
```
./scripts/gen_release_data.py --repo facebook/sapling --out ./src/rawReleaseData.ts
```
Reviewed By: mitrandir77
Differential Revision: D41306411
fbshipit-source-id: 1327d2404f48812c18b844eb5b622acc69eab5e8
