Martin Atkins
f96edbb113
Revise our contributing/development documentation
...
Our documentation for how to contribute was in quite a state of disrepair,
with some documents still describing things as they were before moving
providers into separate repositories, others making assumptions about
Go development that are no longer true in modules mode, and so forth.
This is an attempt at a reset to a good state that should work with the
codebase as it currently stands, and should hopefully serve as a basis
for iterative improvement from here.
These new instructions lean primarily on standard Go toolchain usage and
instruct using the Makefile only for some Terraform-specific situations
that the Go toolchain does not automatically handle. The idea here is that
this direct usage of primary commands in the Go toolchain is less likely
to be broken by changes in future Go releases, and should be immediately
familiar to anyone who has experience with Go development.
2019-10-15 08:39:36 -07:00
Kristin Laemmert
e1d0acda0b
website/contributing: update contribution documentation ( #22883 )
...
* website/contributing: update contribution documentation
This PR seeks to remove outdated and incorrect information. There is
still work to be done updating the information that's left; this is
merely the first step.
2019-09-23 16:21:46 -04:00
Yecheng Fu
ee80499539
docs: install tools before building in docker environment ( #19577 )
...
* docs: install tools before building in docker environment
* Update README.md
Co-Authored-By: Kristin Laemmert <mildwonkey@users.noreply.github.com>
2019-08-19 08:13:27 -04:00
Pam Selle
15c557989f
Merge pull request #18082 from jbwyatt4/patch-1
...
Link to license is broken; now linked to local copy of MPL
2019-08-13 17:14:20 -04:00
The Terraform Team
165e3cc28c
Merge pull request #21906 from ajayk/readme-vagrant-ref
...
readme : remove references to vagrant file
2019-08-05 12:39:34 -04:00
Pam Selle
c44be6e55a
Update README.md
2019-07-12 13:57:07 -04:00
ajayk
f261fa62a9
remove references to vagrant file
2019-06-26 19:41:08 -07:00
Ivan Pedersen
1f990dcd9f
README: Fix typo
2019-03-12 10:40:45 -07:00
Martin Atkins
e6c958048c
build: Document in a machine-readable way that we are now using Go 1.11
2018-10-16 19:14:11 -07:00
Kristin Laemmert
1df423e302
update README.md with current required go version
2018-09-17 08:57:34 -07:00
Dustin J. Mitchell
6de63cfa73
README: Go 1.10 is required for development
2018-07-03 10:35:18 -07:00
Dustin J. Mitchell
78090fcccc
README: describe the "make tools" target
2018-07-03 09:33:31 -07:00
jbwyatt4
1c1eef0e0b
Link to license is broken; now linked to local copy of MPL
2018-05-19 00:16:37 -07:00
Kevin Fishner
8c7ed01416
Update README.md ( #16653 )
2017-11-16 16:15:16 -06:00
Radek Simko
f729ef42ff
docs: Fix logo URL in Readme
2017-09-07 11:14:42 +01:00
Martin Atkins
62d154b9f9
Start building with Terraform 1.9
...
This improves the testing and other tooling and thus allows us to fix
some annoyances. (These fixes will follow in subsequent commits)
2017-08-28 09:59:30 -07:00
Clint
e42130bf14
Update README with link to "Getting started" guide ( #15865 )
...
* Update README with link to "Getting started" guide
* spellin
spell "infrastructure" correctly
2017-08-21 10:55:32 -05:00
fossabot
d6baeef3d7
Add license scan report and status
2017-07-25 14:24:46 -07:00
Martin Atkins
5be673f996
Update README logo URL
...
This now uses the canonical location for the logo image on the main Terraform website.
(The image isn't actually there at the time of this commit, but will be published here as
part of updating the website for the 0.10.0 release.)
2017-07-25 13:49:08 -07:00
Martin Atkins
c57dbebe84
documentation: explain provider dev environment setup
...
The intent here is just to introduce some initial docs on our recommended
way to develop plugins in the same GOPATH as Terraform itself. The
documentation in this area needs some more fundamental rework as it is
rather outdated and mis-organized, but that's outside the scope of what
this change is trying to achieve.
2017-07-18 14:36:01 -07:00
James Nugent
aa1e5e996a
README: Add link to provider repos to "Developing" ( #15546 )
...
This commit adds a link to the GitHub organization which contains the
formerly-built-in providers, and modifies the `plugin-dev` target
documentation to use a provider which is unlikely to be moved out of the
core repository.
2017-07-13 20:59:20 +03:00
Sander van Harmelen
31b8c3c6ad
Update README.md
2017-06-29 08:27:13 +02:00
Alex Rowley
2f4e9a6797
Remove core-dev from README
...
$ make core-dev
make: *** No rule to make target `core-dev'. Stop.
This was removed in #15258
2017-06-22 08:10:54 -07:00
Seth Vargo
d10a8ece43
Fix README logo
2017-04-10 11:54:14 -04:00
Ryan Schlesinger
74710ae71a
Add docker cross compilation instructions ( #12931 )
2017-03-28 15:40:05 +03:00
jugatsu
abe2f9ead1
README: update terraform website url with https ( #12618 )
...
Use HTTPS in terraform website url.
2017-03-12 16:04:18 +02:00
Gauthier Wallet
a5b1a72fda
Updated README.md to use Go 1.8
2017-03-09 14:31:22 +01:00
Mitchell Hashimoto
d36680116c
Update README.md
2017-01-31 11:56:37 -08:00
Eric Krupnik
be739303df
Minor formatting change ( #11031 )
2017-01-04 16:35:32 +00:00
Alexander Fortin
bb9d9dcd3d
README: remove wrong reference to Linux ( #10352 )
2016-11-24 19:36:28 +00:00
Paul Stack
836d17158f
Update README.md
2016-10-26 00:11:39 +01:00
Dan Wendorf
38ed53894a
Link to Gitter chat ( #9612 )
...
IRC has been deprecated in favor of Gitter, this links directly to the Gitter chat room
Signed-off-by: Dave Walter <dwalter@pivotal.io>
2016-10-26 00:09:14 +01:00
Sharif Nassar
f578e319c3
Require Go 1.7
2016-10-13 09:58:59 -07:00
Paul Hinze
ae678c9c5f
README: cleanup whitespace
2016-09-05 15:03:58 -05:00
Manoj
b709d27cf7
Add note on cd'ing into cloned repo ( #8553 )
2016-08-30 18:59:29 +01:00
Brian Hahn
004cec60b3
fix readme numbered indentation ( #7277 )
2016-06-22 23:37:44 +01:00
James Nugent
f91d870537
Update README to reflect govendor vs godep
2016-06-02 23:22:21 -05:00
Julien Vey
92254d90e7
Remove empty software dependencies list in README
2016-04-18 16:51:16 +02:00
Paul Stack
100b7ea4b5
Fix the README file with the correct link to the CONTRBUTING.md ( #6127 )
2016-04-11 13:35:59 -05:00
Paul Hinze
361c1a0992
README.md - expand dependency docs a bit
2016-03-01 12:49:17 -06:00
Paul Hinze
cbd02dd3ef
README: link off to CONTRIBUTING for acctest info
...
Acctest info in README was a bit stale since the enhanced contributing
guide landed.
2016-02-29 12:49:41 -06:00
Paul Hinze
0cf6ba6f64
README/Makefile: Mention & auto-install gox
2016-02-25 06:48:43 -06:00
Paul Hinze
d21b0897a9
Makefile/docs: Lock in 1.6 req, doc vendored deps
...
* Drop Go 1.5 compatibility env vars
* Drop `make updatedeps` from `Makefile` and docs
* Update README w/ vendored dep instructions
2016-02-24 16:13:49 -06:00
Adam Ochonicki
0673fe3273
Remove make updatedeps from README steps
...
As of 0.6.11 `make updatedeps` has been replaced with vendored packages
https://github.com/hashicorp/terraform/issues/4960#issuecomment-178932434
2016-02-23 16:20:43 -05:00
Paul Hinze
10dbf340a6
Build with Go 1.6
...
* Mention requiring Go 1.6+ in the README in preparation for a follow
up PR which updates our docs / Makefile to align with our vendored
dependencies.
2016-02-23 12:58:38 -06:00
James Nugent
54ce59ebdd
Remove release target and document cross-compiling
...
Also document the `plugin-dev` and `core-dev` targets.
2015-12-08 13:10:40 -05:00
Christian Berendt
4a4c41e259
Remove unnecessary tabs from the README file
2015-08-27 10:10:16 +02:00
Aris Pikeas
4e18b78a0c
Add $PATH change to dev instructions
...
`make` failed because it uses `stringer`, which is in `$GOPATH/bin`. Updating $PATH enables a successful build.
2015-06-28 16:14:53 -07:00
Radek Simko
bb864fb527
Increase default timeout for acceptance tests
2015-05-31 17:08:57 +01:00
Clint Shryock
f8e6edb8c3
update README on running acceptance tests. Mostly formatting/typo fix
2015-02-10 14:41:39 -08:00
