aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/docs/getting-started.md
Commit message (Collapse)AuthorAge
* Add missing wordGravatar steren2017-06-26
| | | | | RELNOTES: None PiperOrigin-RevId: 159945909
* 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
* Replace doc pages with redirects to versioned doc pages.Gravatar David Chen2016-08-29
| | | | | | | | | | | | | | * Add a new `redirect` Jekyll layout. * Replace all pages under docs/ with redirects to corresponding page under versions/master/. * Prepend links on Documentation sidebar, including generated navs for the Skylark Library and Build Encyclopedia, with prefix for versioned directory. * Add code to both the internal jekyll-config.sh and external jekyll-tree.sh to add redirect pages for the Skylark Library and Build Encyclopedia. * Bring the branched User Manual doc up to date with latest changes. -- MOS_MIGRATED_REVID=131568800
* Rollback of commit 3e8bcae69a0718cf6972be086706b1841e0ed6b7.Gravatar Damien Martin-Guillerez2016-07-29
| | | | | | | | | | | | | | | | | | | | | | | | | | *** Reason for rollback *** Breaks design docs links *** Original change description *** Move Bazel docs into versioned directory. * Move all Bazel docs (excluding main page, search page, and blog) into versions/master directory. * Replace all original pages with redirects. * Add Jekyll config with default_version setting to specify the default version to redirect docs to. * Add Jekyll config with version_prefix setting specific to pages under each version directory. * Update layouts to generate links to pages for the same version with the version_prefix. * Update Blaze rel... *** -- MOS_MIGRATED_REVID=128690580
* Move Bazel docs into versioned directory.Gravatar David Chen2016-07-27
| | | | | | | | | | | | | | | | | | | | | | | | | | * Move all Bazel docs (excluding main page, search page, and blog) into versions/master directory. * Replace all original pages with redirects. * Add Jekyll config with default_version setting to specify the default version to redirect docs to. * Add Jekyll config with version_prefix setting specific to pages under each version directory. * Update layouts to generate links to pages for the same version with the version_prefix. * Update Blaze release script to copy docs from third_party/bazel/site/versions/master Changes to follow this CL: * Separate navigation from layouts so that navigation can be versioned as well. * Add tool for cutting a release of Bazel docs and copies them into a new version directory. Bug: #579 -- MOS_MIGRATED_REVID=128510319
* Clean up minor spelling / grammar in Getting Started pageGravatar David Herman2016-07-21
| | | | | | | | | | | | Hello, I work for Google but am currently contributing this as an individual. I'm interested in learning Bazel on the side, and as I'm going through the docs, I thought I'd submit code reviews for misc. Bazel site cleanup that I came across (especially for guides that act as a first impression for new users). Let me know if you'd prefer I submit this patch in a different way. Thanks! Closes #1529. -- Reviewed-on: https://github.com/bazelbuild/bazel/pull/1529 MOS_MIGRATED_REVID=128035787
* getting-started.md: fix typo in URLGravatar Klaus Aehlig2016-06-27
| | | | | | | -- Change-Id: Iab790f363ce1029da9706be6be176e4320bdcdb9 Reviewed-on: https://bazel-review.googlesource.com/#/c/3906 MOS_MIGRATED_REVID=125951789
* Replace "Getting Started" page by a Bazel "Hello World"Gravatar Klaus Aehlig2016-06-27
| | | | | | | | | | | | | | As we have a tutorial anyway, keep the "Getting started" page short and language agnositic, and do not duplicate parts that are taught in the tutorial anyway. The main purpose of the "Getting Started" page is to give the reader a quick feeling of the very basic Bazel concepts, as well as allowing to test if Bazel is installed correctly. -- Change-Id: I80baae1c424244d492c202eff0c613cbac187d43 Reviewed-on: https://bazel-review.googlesource.com/#/c/3882 MOS_MIGRATED_REVID=125796405
* docs: add missing '-p' flag to mkdir command in the exampleGravatar Thiago Farina2016-03-21
| | | | | | | | | | | | | | | | | | When passing a path that has some parent directories to mkdir command you also need to pass '-p' flag to tell it to make the parent directories as needed. Otherwise you will get an error like this: mkdir: cannot create directory `src/main/java/com/example/cmdline': No such file or directory This patch fixes this documentation as it was suggested at https://groups.google.com/d/msgid/bazel-discuss/e3d20e6e-9b6f-410f-b80c-67afa9ebc9f9%40googlegroups.com?utm_medium=email&utm_source=footer -- Change-Id: I3075ac66bb7cf42f97139246471e2120838da1e6 Reviewed-on: https://bazel-review.googlesource.com/#/c/3102/ MOS_MIGRATED_REVID=117708676
* Add titles to Bazel documentation pages.Gravatar David Chen2016-01-20
| | | | | | | Fixes #790 -- MOS_MIGRATED_REVID=112563137
* Update links in Bazel docs to point to new BE pages.Gravatar David Chen2015-11-02
| | | | | | | Fixes #529 -- MOS_MIGRATED_REVID=106883457
* Update getting started documentationGravatar Kristina Chodorow2015-08-31
| | | | | -- MOS_MIGRATED_REVID=101955117
* Normalize usage of "workspace", "workspace directory" and "build root" inGravatar Googler2015-08-31
| | | | | | | | | | | | | | | documentation. Replaces instances of "build root" with "workspace directory" as appropriate. Makes the following changes: - /docs/build-ref.html: Adds definition of workspace - /docs/external.md: Replaces "build root" terminology with "workspace" - /docs/getting-started.md: Adds link to workspace definition - /docs/bazel-user-manual.html: Adds link to workspace definition -- MOS_MIGRATED_REVID=101885966
* Fix bad formatting around "runner_deploy.jar"Gravatar NicholasGorski2015-06-05
| | | | | | -- Reviewed-on: https://github.com/google/bazel/pull/228 MOS_MIGRATED_REVID=95282514
* Remove fetch step from compile.shGravatar Kristina Chodorow2015-06-01
| | | | | | | | | | Also updates the fetch documentation. Now that it's been in the wild for a bit, keeping --fetch=true the default seems like the right choice: it's less confusing to new users and anyone who cares can put `build --fetch=false` in their .bazelrc file. -- MOS_MIGRATED_REVID=94912125
* Documentation for the fetch commandGravatar Kristina Chodorow2015-05-15
| | | | | | | I'm expecting some complaints once it's required. -- MOS_MIGRATED_REVID=93318895
* New design for Bazel site.Gravatar Googler2015-04-22
| | | | | -- MOS_MIGRATED_REVID=91768459
* Update Getting Started to make workspace directory concept more clear. Also someGravatar Googler2015-04-15
| | | | | | | | | | | | | Markdown tidying up that doesn't affect the content. Blog post announcing change: [] Preview: -- MOS_MIGRATED_REVID=91108798
* Update getting started instructions with .bazelrc strategyGravatar Kristina Chodorow2015-04-06
| | | | | -- MOS_MIGRATED_REVID=90418845
* Increase visibility of the prerequisites in the getting started doc.Gravatar Googler2015-04-02
| | | | | | | The existing language is a bit parenthetical. -- MOS_MIGRATED_REVID=90096566
* Mention of the final location of the compiled executable and clarify what to ↵Gravatar Googler2015-04-01
| | | | | | | | | | | do with it post-compile, as well as clarify the language around how to use a workspace a bit. Also, move some italics to block-quote. This change is based on my initial checkout of the code and use, and what I would have wanted to have read so I would know what's going on. -- MOS_MIGRATED_REVID=89998892
* Improve site structureGravatar Kristina Chodorow2015-03-31
It's a bit weird having everything under docs/, so this puts the blog and "about" pages under / and all of the documentation under docs. -- MOS_MIGRATED_REVID=89965504
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-09 09:11:35 +0000