aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/docs/best-practices.md
Commit message (Collapse)AuthorAge
* Fixed broken links to user manual in docsGravatar Jingwen Chen2018-03-05
| | | | | | | | The user manual filename has been renamed from `bazel-user-manual.html` to `user-manual.html`. Closes #4662. PiperOrigin-RevId: 187877241
* docs: improve ambiguous sentence. Fixes #3503.Gravatar buchgr2017-12-21
| | | | | RELNOTES: None PiperOrigin-RevId: 179815290
* Remove the word 'Skylark' when it doesn't add any value.Gravatar laurentlb2017-12-14
| | | | | | | | | | | The word Skylark tends to be overused. We should use it only when we refer to the language itself. In many places, the word 'Skylark' was used, even if the reader may not know it (e.g. "create a rule" is clearer than "create a Skylark rule"). RELNOTES: None. PiperOrigin-RevId: 179024448
* Fix spelling errors in site docsGravatar Akira Baruah2017-11-06
| | | | | | | | I used [GNU Aspell](http://aspell.net/) to quickly look through markdown files in `site/docs/` for typos. Still involved a bit of manual checking, but ultimately found a handful of spelling errors. Closes #3944. PiperOrigin-RevId: 174490875
* Add a link for the bazel.rc/.bazelrc formatGravatar Stefan Sauer2017-11-03
| | | | | | Closes #4009. PiperOrigin-RevId: 174380096
* Create the "C++ and Bazel" and "Java and Bazel" pages.Gravatar Googler2017-09-14
| | | | PiperOrigin-RevId: 168687598
* Fix table of contents for the BUILD file style guide.Gravatar Yilei Yang2017-08-02
| | | | | | | | The "BUILD files" section in best-practices has been moved to skylark/build-style. Closes #3470. PiperOrigin-RevId: 163962064
* Move some best practices to the BUILD file style guide.Gravatar laurentlb2017-07-20
| | | | | RELNOTES: None. PiperOrigin-RevId: 162501299
* Fix paths in Bazel docs, removing references to versions/master.Gravatar dzc2017-06-08
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Follow-up to https://github.com/bazelbuild/bazel/commit/22b85a2a3c79c6f3aef1e0a61e485bb135be4551. This change updates paths and URLs to Bazel docs, removing the versions/master directory and changing bazel.build/docs to docs.bazel.build. For clarification on the convention of the docs site, links referencing docs.bazel.build/foo.html will be redirected to docs.bazel.build/versions/master/foo.html. The versions/master directory will contain the documentation pages pushed from HEAD. Once versioned documentation is ready, then docs.bazel.build/foo.html will instead be redirected to docs.bazel.build/x.y.z/foo.html, where x.y.z is the directory for the latest stable Bazel version. Follow-ups to this change: * Add script that will be used by the daily push job that pushes the latest documentation from HEAD to docs.bazel.build. This script will do the following: * Build the Jekyll tree, run jekyll build, and modify the resulting site tree, moving the docs/ directory into versions/master. * Add redirects for each of the site pages from the root of the site to the corresponding page in versions/master. * This should give us the minimum viable product for the new docs site. * Add script for cutting a release of the docs and pushing to a new versioned directory on the docs.bazel.build bucket. RELNOTES: None PiperOrigin-RevId: 158347197
* Restructure site/ directory into docs/ which only contains Bazel documentation.Gravatar dzc2017-06-01
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The new docs/ directory in the bazel source tree will only contain the Bazel docs site, which is hosted at docs.bazel.build. This change deletes the marketing site and blog, which have been migrated to the bazel-website and bazel-blog GitHub repositories respectively. This change also updates the serve-docs.sh and ci/build.sh under scripts/ in preparation for publishing the docs site. Note that to help make reviews more manageable, this change is limited to moving files to their new locations. Here are the follow-up changes: * Update all links in docs to remove versions/master in paths and to add correct bazel.build subdomain when linking to pages on the marketing site or the blog. * Set up versioned directories on GCS bucket and add tooling for versioning docs This change is also coordinated with https://bazel-review.googlesource.com/c/11568/ to have the PublishSite job publish to docs.bazel.build rather than www.bazel.build. Issue #2397 RELNOTES: None PiperOrigin-RevId: 157612651
* Add best practices docGravatar kchodorow2017-05-02
PiperOrigin-RevId: 154734540