Commit Graph

37 Commits

Author SHA1 Message Date
Michael Bolin
d59f952372 list Linux third on Installation since it currently has the fewest downloads (#245)
Summary: Pull Request resolved: https://github.com/facebook/sapling/pull/245

Test Plan: http://localhost:3000/

Reviewed By: MichaelCuevas

Differential Revision: D41452967

Pulled By: bolinfest

fbshipit-source-id: b100be7831fee99c61bf74fedbe54b487a3454b7
2022-11-21 16:35:53 -08:00
Michael Bolin
596bc1c363 remove $ from some examples to make it easier to copy/paste (#244)
Summary: Pull Request resolved: https://github.com/facebook/sapling/pull/244

Test Plan: http://localhost:3000/

Reviewed By: MichaelCuevas

Differential Revision: D41452964

Pulled By: bolinfest

fbshipit-source-id: 33caf34901cac31c43b0a90ab358b8099c9ba342
2022-11-21 16:35:53 -08:00
Michael Bolin
ff9a41ecbe make the Ubuntu installation instructions copy/pasteable (#243)
Summary: Pull Request resolved: https://github.com/facebook/sapling/pull/243

Test Plan: http://localhost:3000/

Reviewed By: muirdm

Differential Revision: D41452966

Pulled By: bolinfest

fbshipit-source-id: 997a062ef56efe68232bb78fcf7bdbb7eb9593a9
2022-11-21 16:35:53 -08:00
Jun Wu
c63edcd541 website: update internals docs
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
2022-11-21 11:51:00 -08:00
Jun Wu
830ca4a73c website: "Foo Bar" => "Foo bar" title for more pages
Summary: Done by the script added in D41312633 (088f5efc9b).

Reviewed By: muirdm

Differential Revision: D41385131

fbshipit-source-id: e6bf1cd874bb870382fac147398a55f2851044d6
2022-11-21 11:51:00 -08:00
Sharath Chandra
1b5fb2af55 Fix typo. Unstach => Unstash (#238)
Summary:
Fix typo. `Unstach` => `Unstash`. In file `git-cheat-sheet.md`

Pull Request resolved: https://github.com/facebook/sapling/pull/238

Reviewed By: mitrandir77

Differential Revision: D41434044

Pulled By: mzr

fbshipit-source-id: 072ff85c1a26e2e5a5f3eadf7312305a81f6c642
2022-11-21 09:10:08 -08:00
mjarrowsmith4
b7636b8547 Fix typo (#232)
Summary:
This PR fixes a very small typo: `TEST_ENVRIONMENT` -> `TEST_ENVIRONMENT`

Pull Request resolved: https://github.com/facebook/sapling/pull/232

Reviewed By: yancouto

Differential Revision: D41430475

Pulled By: MichaelCuevas

fbshipit-source-id: 02ba09cd88529c36036a671eafdf57ff297c8411
2022-11-21 03:44:47 -08:00
Artur Carvalho
439c9b6a3f Improve text (#217)
Summary:
Hello there,

Small improvement to the text.

Pull Request resolved: https://github.com/facebook/sapling/pull/217

Reviewed By: MichaelCuevas

Differential Revision: D41424082

Pulled By: mzr

fbshipit-source-id: f4172fd7f963267feb991944c74fff42beb52385
2022-11-19 11:12:58 -08:00
Michael Bolin
a6be406c87 add backticks to make code samples more readable
Reviewed By: evangrayk

Differential Revision: D41420268

fbshipit-source-id: 624fad59306c236183ae7e01aa41426313cfbc89
2022-11-18 18:27:04 -08:00
Michael Bolin
7eb1191b20 increase column length so Prettier formats tables
Reviewed By: evangrayk

Differential Revision: D41420171

fbshipit-source-id: 8b93f1181c892a5abd1fcbe0d2f3d09ada3b202b
2022-11-18 18:27:04 -08:00
JT Smith
a6f9430448 Fix typo in docs (#164)
Summary: Pull Request resolved: https://github.com/facebook/sapling/pull/164

Reviewed By: sggutier

Differential Revision: D41418591

Pulled By: bolinfest

fbshipit-source-id: 47108d92cff587cc0206e32db55b0b25fe353195
2022-11-18 16:51:46 -08:00
Michael Bolin
99445756be update the web documentation for sl ghstack
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
2022-11-18 12:28:25 -08:00
Waleed Khan
91bf257ec2 Adjust git reset --hard in Git cheat sheet (#152)
Summary:
Closes https://github.com/facebook/sapling/issues/150

Pull Request resolved: https://github.com/facebook/sapling/pull/152

Reviewed By: akushner

Differential Revision: D41347444

Pulled By: bolinfest

fbshipit-source-id: f1cfb714253fa32b76ea301babe8823dff15b23b
2022-11-17 11:54:20 -08:00
Keith Smiley
ec72a792c4 Fix gh CLI spelling (#157)
Summary:
Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/keith/sapling/pull/157).
* __->__ https://github.com/facebook/sapling/issues/157
* https://github.com/facebook/sapling/issues/156

Fix gh CLI spelling

Pull Request resolved: https://github.com/facebook/sapling/pull/157

Reviewed By: bolinfest

Differential Revision: D41347361

Pulled By: genevievehelsel

fbshipit-source-id: 1cc8ff9f8292ad64d8833b536a00639c686bde56
2022-11-17 10:12:12 -08:00
Mark Juggurnauth-Thomas
c96ad3c5cc docs: colorize smartlog example
Summary: Colorize the smartlog example so it matches terminal output.

Reviewed By: quark-zju

Differential Revision: D41314885

fbshipit-source-id: 7d85517b8acf7596a35133b0429c91b5b2ca4464
2022-11-16 16:01:46 -08:00
Keith Smiley
e391c6ba7c Fix rendering of clone example (#156)
Summary:
Stack created with [Sapling](https://sapling-scm.com). Best reviewed with [ReviewStack](https://reviewstack.dev/keith/sapling/pull/156).
* https://github.com/facebook/sapling/issues/157
* __->__ https://github.com/facebook/sapling/issues/156

Fix rendering of clone example

 Since this was already in a codeblock these backticks also rendered on https://sapling-scm.com/docs/overview/basic-commands

Pull Request resolved: https://github.com/facebook/sapling/pull/156

Reviewed By: bolinfest

Differential Revision: D41347403

Pulled By: genevievehelsel

fbshipit-source-id: 925cd3a9c83556698f3c647af4f4532bf3f82bf9
2022-11-16 13:47:57 -08:00
Mateusz Kwapich
b0f8508602 s/sl checkout/sl goto/g
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
2022-11-16 12:22:50 -08:00
Jun Wu
4c1994cd38 website: internals/drawdag
Summary:
Explain the drawdag DSL and show some examples.
This also serves as testing the WASM bindings.

Reviewed By: muirdm

Differential Revision: D41252231

fbshipit-source-id: 575c3019ff7f8bc758c9dcd1046bcf7f2db837bf
2022-11-15 16:43:12 -08:00
Jun Wu
fe5ab6dcfd website: mention hgignore
Summary: Sapling only supports gitignore.

Reviewed By: DurhamG

Differential Revision: D41312748

fbshipit-source-id: 91f884084cb4ae05690d3117a69902da35405b70
2022-11-15 14:24:51 -08:00
Jun Wu
a19c62d7ec website: internals/metalog
Summary: Describe the metalog. Hopefully it can be interesting to certain folks.

Reviewed By: muirdm

Differential Revision: D41293057

fbshipit-source-id: d0624ff2900b263788d5c0b57cbf1541bd0222e3
2022-11-15 13:37:15 -08:00
kurtz.brandon@gmail.com
dffb1fcccb fixes typo in sapling-stack.md (#142)
Summary: Pull Request resolved: https://github.com/facebook/sapling/pull/142

Reviewed By: genevievehelsel

Differential Revision: D41315996

Pulled By: bolinfest

fbshipit-source-id: 617d6c7f63c38bb03bb91a3db0843e93f9912f66
2022-11-15 12:54:33 -08:00
Jun Wu
b58cf8f463 website: internals/indexedlog
Summary:
Describe the indexedlog with background and high-level ideas. Hopefully it can
be interesting to certain folks.

Reviewed By: muirdm, akushner

Differential Revision: D41287715

fbshipit-source-id: c438fdbe88a984e1867b0cca94bbf45f4e195efe
2022-11-15 12:06:45 -08:00
Jun Wu
e039492a69 website: edit git-cheat-sheet
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
2022-11-15 11:02:57 -08:00
Jun Wu
088f5efc9b website: use Foo bar title
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
2022-11-15 11:02:57 -08:00
Evan Krause
1ec97ebdc9 Add note to install sapling to use vscode extension
Summary:
The  vscode extension does not bundle sapling, thus you must also install sapling with the normal instructions in order to use the extension.

We should add this to the website docs, as well as the README for the VS Code extension (which appears inside the vscode marketplace)

Reviewed By: DurhamG

Differential Revision: D41309780

fbshipit-source-id: 4caad13f5c478252324e6cd3874ef25c0bd735d8
2022-11-15 10:49:31 -08:00
Mark Juggurnauth-Thomas
aaaa8275d7 docs: minor fixes and rewording
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
2022-11-15 10:47:29 -08:00
Mark Juggurnauth-Thomas
d926c3089b docs: add visibility and mutation documentation
Summary: Add documenation for Sapling's visibility and mutation tracking.

Reviewed By: quark-zju

Differential Revision: D41292893

fbshipit-source-id: f14942bcaebb8e9875422d25b22196740e259f7e
2022-11-15 10:47:29 -08:00
Jun Wu
fa63ff539a website: internals/linelog
Summary:
Describe the linelog stuff. It might be interesting to other source control
folks.

Reviewed By: muirdm

Differential Revision: D41279087

fbshipit-source-id: edca1fd7722cae32fdcb4908fab3e6c7d474fc19
2022-11-15 08:59:02 -08:00
Jun Wu
d98a0a9077 website: internals/zstdelta
Summary:
Describe the zstdelta algorithm. It might be interesting to other source
control folks.

Reviewed By: muirdm

Differential Revision: D41275018

fbshipit-source-id: 8e44c3e23716c9130eaaedf751575d37f81e7696
2022-11-15 08:45:09 -08:00
Mateusz Kwapich
dd98b87254 warn about macOS file limit
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
2022-11-15 08:37:25 -08:00
Michael Bolin
74e4f292ae prefer -O to -o when using curl
Summary: Follow-up from D41306411 (ce3095ed47).

Reviewed By: DurhamG

Differential Revision: D41307219

fbshipit-source-id: bcabe12cbbf930d031bc9e8490606f94c2a0a347
2022-11-15 07:57:16 -08:00
Muir Manders
06f447cd2c website: regenerate command docs
Summary: There are a few alias reductions not incorporated yet.

Reviewed By: bolinfest

Differential Revision: D41306456

fbshipit-source-id: f60aa3b020b7d50c871003d7360b2ea116574190
2022-11-15 07:52:09 -08:00
Jun Wu
5c56f080f7 website: minor tweaks of sidebar
Summary:
- Move scale/overview to top in section
- Remove scale/segmented-changelog as it is blank (plan to be an internal page)
- Rename internals/difference-from-hg

Reviewed By: yancouto

Differential Revision: D41306674

fbshipit-source-id: aa9cb2bf853aceaabcaa400e7918cf4725a6c24f
2022-11-15 07:35:36 -08:00
Michael Bolin
ce3095ed47 tighten up installation instructions for macOS
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
2022-11-15 07:21:34 -08:00
Facebook Community Bot
79efe98a13 Re-sync with internal repository 2022-11-15 06:39:33 -08:00
Jun Wu
882fdeebee doc: scale/overview
Summary: List the scalability work we add over time.

Reviewed By: DurhamG

Differential Revision: D41189125

fbshipit-source-id: bf0bbb57fded6608e0b70c402fd2449aee5d6dd3
2022-11-15 06:30:03 -08:00
Facebook Community Bot
5076656c62 Re-sync with internal repository 2022-11-15 00:48:09 -08:00