Skip to content

Commit bbd6320

Browse files
committed
Update README with new preview and pull request instructions
Revert the now-unused preview code and supporting files.
1 parent 748ed4d commit bbd6320

File tree

3 files changed

+22
-142
lines changed

3 files changed

+22
-142
lines changed

.gitignore

Lines changed: 0 additions & 17 deletions
This file was deleted.

README.md

Lines changed: 22 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -37,38 +37,27 @@ paragraph reflows make future maintainers cry.
3737
Relevant Pages
3838
--------------
3939

40-
The relevant modified style guides used by Drake are:
40+
The subset of the style guides used by Drake are:
4141

42-
* C++ Style Guide:
43-
[local preview](./cppguide.html) |
44-
[rendered online](https://drake.mit.edu/styleguide/cppguide.html)
45-
* Python Style Guide:
46-
[local preview](./pyguide.html)\* |
47-
[rendered online](https://drake.mit.edu/styleguide/pyguide.html)
48-
49-
\* These docs must be generated to preview locally. Please see
50-
<https://drake.mit.edu/documentation_instructions.html> for instructions.
42+
* C++ Style Guide (aka cppguide)
43+
* Python Style Guide (aka pyguide)
5144

5245
Making New Changes
5346
------------------
5447

55-
Branch, update, and PR as you would any other Drake change.
48+
Branch, edit, and PR to `styleguide` as you would any other Drake change.
5649

57-
Ensure that Drake is updated. See [Updating Drake](#updating-drake) for more
58-
information.
50+
Pull requests merged to the `main` branch here will not be reflected on
51+
the https://drake.mit.edu/styleguide website until you also PR to Drake
52+
to update the git sha it uses for `styleguide`.
53+
54+
See [Updating Drake](#updating-drake) for more information.
5955

6056
Previewing Changes
6157
------------------
6258

63-
Generally, you can preview changes locally without any build. However, if a page
64-
is denoted as needing generation, you can view them locally by running this
65-
script which will indicate necessary prereqs:
66-
67-
./preview_site_jekyll.py
68-
69-
You can alternatively preview them on your own GitHub fork.
70-
71-
<!-- TODO(eric): Document this workflow. -->
59+
See https://drake.mit.edu/documentation_instructions.html for how to preview
60+
your changes.
7261

7362
Pulling Upstream Changes
7463
------------------------
@@ -96,13 +85,12 @@ updates:
9685
cd styleguide
9786

9887
* Add a "drake" remote for the Drake styleguide and make it the default
99-
upstream. Note that for compatibility with Google, we use the branch
100-
`gh-pages` as our master:
88+
upstream.
10189

10290
git remote add drake https://github.com/RobotLocomotion/styleguide.git
10391
git remote set-url --push drake no_push
10492
git fetch drake
105-
git branch --set-upstream-to drake/gh-pages
93+
git branch --set-upstream-to drake/main
10694

10795
* Add a "google" remote for the Drake styleguide:
10896

@@ -112,7 +100,7 @@ updates:
112100
Now that you have a repository and remotes set up, you want to be up-to-date
113101
with Drake and then pull Google's changes:
114102

115-
git checkout gh-pages
103+
git checkout main
116104
git pull --ff-only
117105
git checkout -b **NEW_BRANCH_NAME**
118106
git pull google gh-pages
@@ -139,23 +127,24 @@ Updating Drake
139127
--------------
140128

141129
Whenever a change to `styleguide` is made, be sure to submit a PR to `drake` to
142-
bump the `styleguide` SHA.
130+
bump the `styleguide` git sha.
143131

144-
If there are no changes to supporting code (e.g. `cpplint`):
132+
If there are no changes `cpplint`:
145133

146-
1. Submit `styleguide` PR, and follow normal review process.
147-
2. Submit `drake` PR, reference the `styleguide` PR, and follow normal review
148-
process.
134+
1. Submit `styleguide` PR, and follow normal review process, finally merging
135+
into the `main` branch of this repository.
136+
2. Submit `drake` PR to bump the `styleguide` git sha, and follow the normal
137+
review process.
149138

150-
If there **are** changes to supporting code:
139+
If there **are** changes to `cpplint`:
151140

152141
1. Submit the `styleguide` PR.
153142
2. Submit the `drake` PR, reference the `styleguide` PR, and mark as
154143
`do not merge`.
155144
3. Wait until `drake` `*-release` tests pass.
156145
4. Assign review for `styleguide` PR. Merge once review is done.
157146
5. Update the `drake` PR to use the `styleguide` merge commit (from
158-
`gh-pages`). Follow normal review process.
147+
the `main` branch; not the PR's git sha). Follow normal review process.
159148

160149
--
161150

preview_site_jekyll.py

Lines changed: 0 additions & 92 deletions
This file was deleted.

0 commit comments

Comments
 (0)