aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/docs/external.md
Commit message (Collapse)AuthorAge
* Fix multi line code blocksGravatar dannark2018-07-19
| | | | | RELNOTES: None PiperOrigin-RevId: 205281433
* Add anchor tags to external.md page for actual linkability!Gravatar dannark2018-07-17
| | | | | RELNOTES: None PiperOrigin-RevId: 204969740
* Add doc about repo_mappingGravatar dannark2018-07-17
| | | | | RELNOTES: None PiperOrigin-RevId: 204948309
* cc_library for ext build rule example to fit '.so'Gravatar David Newgas2018-03-05
| | | | | | | | The example for Depending on non-Bazel projects describes depending on a .so file. java_library builds .jar files, so is inconsistent.This PR switches the example to use cc_library, which actually builds a .so file so matches the description. Closes #4745. PiperOrigin-RevId: 187839898
* Use valid name for local_repository example in external project docsGravatar Akira Baruah2017-11-23
| | | | | | | | Addresses #4018 Closes #4020. PiperOrigin-RevId: 176750087
* Rename bazel-user-manual.html into user-manual.htmlGravatar dmarting2017-09-04
| | | | PiperOrigin-RevId: 167477112
* Add an introduction to what external repositories areGravatar kchodorow2017-07-28
| | | | PiperOrigin-RevId: 163348233
* For topic about generate_workspace tool, fixed broken links and did some ↵Gravatar Googler2017-07-05
| | | | | | rewording. PiperOrigin-RevId: 160955003
* Describe the tool `generate_workspace` in a separate topic. Update ↵Gravatar Googler2017-07-03
| | | | | | instructions for generating a WORKSPACE file. PiperOrigin-RevId: 160673799
* Remove misleading documentation about 'transitive-deps' targetGravatar Jeremy Apthorp2017-06-28
| | | | | | | This target is not actually generated by generate_workspace. Change-Id: Idcaa138bf56021b281138d60a06befa8c9579b1d PiperOrigin-RevId: 160295136
* Use relative paths in links in docs.Gravatar dzc2017-06-26
| | | | | | | | | | | | | | | | This change fixes links among Bazel docs to use relative paths links instead of absolute path (either full URL or absolute from site root). This way, versioned documentation will link to other pages within the same versioned directory rather than to the site root, which will point to the latest version of the page from HEAD. Future improvements may include adding a lint tool to check links in documentation to ensure that the correct convention is followed such that all links to pages within a version of the docs will point to pages within the same version. RELNOTES: None PiperOrigin-RevId: 160117865
* 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
* 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
* clarified needing to run generate_workspace from bazel source folderGravatar Ittai Zeidman2016-07-14
| | | | | | | | | | | Hi, If you feel this is unnecessary please feel free to close this PR but it took me some time and @lberki's help to understand that even though I built the binary from source and I have the source cloned then I still need to run the command from the source folder so I added that note in. Closes #1489. -- Reviewed-on: https://github.com/bazelbuild/bazel/pull/1489 MOS_MIGRATED_REVID=127429574
* Update external dependencies documentation to mention the --artifact ↵Gravatar Alex Humesky2016-02-23
| | | | | | | argument to generate_workspace. -- MOS_MIGRATED_REVID=115367724
* Suggest using release tag when running generate_workspaceGravatar Dan Fabulich2016-01-26
| | | | | | | | Apropos issue #776. This hint in the doc would have saved me from filing a bogus bug. -- Reviewed-on: https://github.com/bazelbuild/bazel/pull/778 MOS_MIGRATED_REVID=112972220
* Add titles to Bazel documentation pages.Gravatar David Chen2016-01-20
| | | | | | | Fixes #790 -- MOS_MIGRATED_REVID=112563137
* Add support for downloading through proxiesGravatar Kristina Chodorow2015-12-22
| | | | | | | Fixes #587. -- MOS_MIGRATED_REVID=110785300
* External repository documentation improvementsGravatar Kristina Chodorow2015-11-26
| | | | | -- MOS_MIGRATED_REVID=108717933
* Update links in Bazel docs to point to new BE pages.Gravatar David Chen2015-11-02
| | | | | | | Fixes #529 -- MOS_MIGRATED_REVID=106883457
* Fix minor typos in external.mdGravatar Googler2015-09-11
| | | | | -- MOS_MIGRATED_REVID=102859533
* Move generate_workspace to src/toolsGravatar Kristina Chodorow2015-09-04
| | | | | | | | Seems like a better location for it (easier for people to run than src/main/java/com/google/devtools/build etc). -- MOS_MIGRATED_REVID=102354250
* 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
* Minor documentation fixes. Make sidebar navigation look more consistent.Gravatar David Chen2015-07-27
| | | | | -- MOS_MIGRATED_REVID=98934930
* Make generate_workspace also generate a BUILD file with transitive depsGravatar Kristina Chodorow2015-07-23
| | | | | | | Fixes #89. -- MOS_MIGRATED_REVID=98832811
* Add a separate section for workspace rules in the encyclopediaGravatar Kristina Chodorow2015-07-08
| | | | | -- MOS_MIGRATED_REVID=97771662
* Make generate_workspace dump transitive dependencies for Maven artifactsGravatar Kristina Chodorow2015-06-25
| | | | | | | | | | | This moves the WORKSPACE-parsing code out of WorkspaceFileFunction.java so generate_workspace can parse a WORKSPACE into an ExternalPackage without having to muck with Skyframe. Addresses issue #89. -- MOS_MIGRATED_REVID=96777708
* Add pom.xml parserGravatar Kristina Chodorow2015-06-08
This doesn't do transitive dependencies yet, but it parses a pom.xml file and turns it into a WORKSPACE file. -- MOS_MIGRATED_REVID=95305450