Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate docs to registry-compatible structure #250

Merged
merged 21 commits into from
Aug 19, 2020
Merged

Migrate docs to registry-compatible structure #250

merged 21 commits into from
Aug 19, 2020

Conversation

nfx
Copy link
Contributor

@nfx nfx commented Aug 17, 2020

  • Consolidate all documentation under docs/ folder.
  • Add more extensive examples for all of documentation items.
  • Remove legacy website, further removing third-party code from this repository.

@nfx nfx requested a review from stikkireddy August 17, 2020 18:54
@TravisBuddy
Copy link

Travis tests have failed

Hey @nfx,
Please read the following log in order to understand the failure reason.
It'll be awesome if you fix what's wrong and commit the changes.

2nd Build

View build log

curl -sSL "https://github.com/gotestyourself/gotestsum/releases/download/v0.4.2/gotestsum_0.4.2_linux_amd64.tar.gz" | sudo tar -xz -C /usr/local/bin gotestsum
The command "curl -sSL "https://github.com/gotestyourself/gotestsum/releases/download/v0.4.2/gotestsum_0.4.2_linux_amd64.tar.gz" | sudo tar -xz -C /usr/local/bin gotestsum" exited with 0.
$ curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.25.0
golangci/golangci-lint info checking GitHub for tag 'v1.25.0'
golangci/golangci-lint info found version: 1.25.0 for v1.25.0/linux/amd64
golangci/golangci-lint info installed /home/travis/gopath/bin/golangci-lint
The command "curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.25.0" exited with 0.
$ time make lint
✓ Linting source code with golangci-lint make sure you run make fmt ...
storage/acceptance/adls_gen1_test.go:42: File is not `gofmt`-ed with `-s` (gofmt)
}
Makefile:10: recipe for target 'lint' failed
make: *** [lint] Error 1

real	0m28.056s
user	0m48.785s
sys	0m1.671s
The command "time make lint" exited with 2.
$ time make test
✓ Running tests...
∅  .
✓  access (76ms) (coverage: 90.6% of statements)
✓  access/acceptance (35ms)
✓  common (19ms) (coverage: 69.5% of statements)
✓  compute (1.041s) (coverage: 68.5% of statements)
✓  compute/acceptance (15ms)
✓  identity (67ms) (coverage: 42.4% of statements)
✓  identity/acceptance (14ms)
✓  internal (13ms) (coverage: 67.3% of statements)
∅  internal/acceptance
∅  internal/qa
✓  internal/sanity (11ms) (coverage: 100.0% of statements)
✓  mws (1.053s) (coverage: 70.5% of statements)
✓  mws/acceptance (51ms)
✓  provider (24ms) (coverage: 52.5% of statements)
✓  storage (90ms) (coverage: 72.2% of statements)
✓  storage/acceptance (690ms)
✓  workspace (1.66s) (coverage: 66.5% of statements)
✓  workspace/acceptance (12ms)

DONE 499 tests, 64 skipped in 50.603s

real	0m50.609s
user	0m35.616s
sys	0m4.647s
The command "time make test" exited with 0.
$ time make build
✓ Building source code with go build...

real	0m4.046s
user	0m3.318s
sys	0m0.512s
The command "time make build" exited with 0.
store build cache
changes detected (content changed, file is created, or file is deleted):\n/home/travis/.cache/go-build/00/00fc9a4117e1a927f8390f5653b11ca2e28dcc2afc4a8839755d6b8429e7de0e-a
/home/travis/.cache/go-build/02/021ed6fdc50cb06018984c3b879a7818877485b204ab5fd82e5d70c9f7a7c99f-a
/home/travis/.cache/go-build/02/02bbbdfef0783a19dee155b97875436e9921f266ad015a8b17e94cf960e208fc-a
/home/travis/.cache/go-build/04/049b258529e470e705d330024cce02aa357fd0332b531da15f0fe0d1eb053e69-d
/home/travis/.cache/go-build/05/0558bb865d1a6619674d35e06799ad28796636bb7d3f694076c6d960cd8fb93e-a
/home/travis/.cache/go-build/08/0889cebd3b7dd420b825779cff3f5b25efc0a0a502d21508f8d792b8f8764e86-a
/home/travis/.cache/go-build/08/08ae2336e17e358962b444fbbb9610c5a0852b52952df6640d4a71b0aff0b5ad-a
/home/travis/.cache/go-build/0b/0b0e1ba098e4c677e1aede84fbcf1882f474477ecf09879f6df4e3930b32ecea-a
/home/travis/.cache/go-build/0b/0b2b7244abc1e886eb489289d591df3ad4765e7deda9ca710f94cd3e6aca3576-a
/home/travis/.cache/go-build/0f/0f16b9ccd9fcfce09f2d8757c2e60cf45a0287b6e0f461dbfff3b573f6961a9c-a
/home/trav\n...
changes detected, packing new archive
uploading PR.250/cache--linux-xenial-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855--go-1.14.x.tgz
cache uploaded


Done. Your build exited with 1.
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.25.0
golangci/golangci-lint info checking GitHub for tag 'v1.25.0'
golangci/golangci-lint info found version: 1.25.0 for v1.25.0/linux/amd64
golangci/golangci-lint info installed /home/travis/gopath/bin/golangci-lint
time make lint
✓ Linting source code with golangci-lint make sure you run make fmt ...
storage/acceptance/adls_gen1_test.go:42: File is not `gofmt`-ed with `-s` (gofmt)
}
Makefile:10: recipe for target 'lint' failed
make: *** [lint] Error 1

real	0m28.056s
user	0m48.785s
sys	0m1.671s
TravisBuddy Request Identifier: 89f34870-e0bb-11ea-a6dd-d374b9ca78b0

@TravisBuddy
Copy link

Travis tests have failed

Hey @nfx,
Please read the following log in order to understand the failure reason.
It'll be awesome if you fix what's wrong and commit the changes.

2nd Build

View build log

curl -sSL "https://github.com/gotestyourself/gotestsum/releases/download/v0.4.2/gotestsum_0.4.2_linux_amd64.tar.gz" | sudo tar -xz -C /usr/local/bin gotestsum
The command "curl -sSL "https://github.com/gotestyourself/gotestsum/releases/download/v0.4.2/gotestsum_0.4.2_linux_amd64.tar.gz" | sudo tar -xz -C /usr/local/bin gotestsum" exited with 0.
$ curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.25.0
golangci/golangci-lint info checking GitHub for tag 'v1.25.0'
golangci/golangci-lint info found version: 1.25.0 for v1.25.0/linux/amd64
golangci/golangci-lint info installed /home/travis/gopath/bin/golangci-lint
The command "curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.25.0" exited with 0.
$ time make lint
✓ Linting source code with golangci-lint make sure you run make fmt ...
storage/acceptance/adls_gen1_test.go:42: File is not `gofmt`-ed with `-s` (gofmt)
}
Makefile:10: recipe for target 'lint' failed
make: *** [lint] Error 1

real	0m29.167s
user	0m49.380s
sys	0m1.570s
The command "time make lint" exited with 2.
$ time make test
✓ Running tests...
∅  .
✓  access (59ms) (coverage: 90.6% of statements)
✓  access/acceptance (17ms)
✓  common (19ms) (coverage: 69.5% of statements)
✓  compute (645ms) (coverage: 68.5% of statements)
✓  compute/acceptance (16ms)
✓  identity (72ms) (coverage: 42.4% of statements)
✓  identity/acceptance (17ms)
✓  internal (14ms) (coverage: 67.3% of statements)
∅  internal/acceptance
∅  internal/qa
✓  internal/sanity (13ms) (coverage: 100.0% of statements)
✓  mws (1.065s) (coverage: 70.5% of statements)
✓  mws/acceptance (15ms)
✓  provider (25ms) (coverage: 52.5% of statements)
✓  storage (510ms) (coverage: 72.2% of statements)
✓  storage/acceptance (630ms)
✓  workspace (1.642s) (coverage: 66.5% of statements)
✓  workspace/acceptance (13ms)

DONE 499 tests, 64 skipped in 45.793s

real	0m45.801s
user	0m33.252s
sys	0m4.825s
The command "time make test" exited with 0.
$ time make build
✓ Building source code with go build...

real	0m3.432s
user	0m3.699s
sys	0m0.525s
The command "time make build" exited with 0.
store build cache
changes detected (content changed, file is created, or file is deleted):\n/home/travis/.cache/go-build/05/0558bb865d1a6619674d35e06799ad28796636bb7d3f694076c6d960cd8fb93e-a
/home/travis/.cache/go-build/08/0889cebd3b7dd420b825779cff3f5b25efc0a0a502d21508f8d792b8f8764e86-a
/home/travis/.cache/go-build/08/08ae2336e17e358962b444fbbb9610c5a0852b52952df6640d4a71b0aff0b5ad-a
/home/travis/.cache/go-build/0b/0b2b7244abc1e886eb489289d591df3ad4765e7deda9ca710f94cd3e6aca3576-a
/home/travis/.cache/go-build/0f/0f16b9ccd9fcfce09f2d8757c2e60cf45a0287b6e0f461dbfff3b573f6961a9c-a
/home/travis/.cache/go-build/0f/0fdf9101bf798e955e4ab0d1d72cea4319a658fe87ce3735572fcc74b9404ec3-a
/home/travis/.cache/go-build/13/134bd8dfc182893b4fbe7273c1275a1a419423343cd44f8b55106b0198c81e82-a
/home/travis/.cache/go-build/1d/1d829a37d399cde9cfc6a85b9e09a14902b11f533aaa7c02681db159132831d7-a
/home/travis/.cache/go-build/1f/1ff58a15a1defdfc75a13df123edf8c3b0f23c184bc92aca805118c2d33a7f32-a
/home/travis/.cache/go-build/20/201f5eef0f8fe6875424bf67d1aaa64d8aa1d2d31abf7378c009e5bf844d25c4-a
/home/trav\n...
changes detected, packing new archive
uploading PR.250/cache--linux-xenial-e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855--go-1.14.x.tgz
cache uploaded


Done. Your build exited with 1.
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.25.0
golangci/golangci-lint info checking GitHub for tag 'v1.25.0'
golangci/golangci-lint info found version: 1.25.0 for v1.25.0/linux/amd64
golangci/golangci-lint info installed /home/travis/gopath/bin/golangci-lint
time make lint
✓ Linting source code with golangci-lint make sure you run make fmt ...
storage/acceptance/adls_gen1_test.go:42: File is not `gofmt`-ed with `-s` (gofmt)
}
Makefile:10: recipe for target 'lint' failed
make: *** [lint] Error 1

real	0m29.167s
user	0m49.380s
sys	0m1.570s
TravisBuddy Request Identifier: 2d827e40-e0c4-11ea-a6dd-d374b9ca78b0

@TravisBuddy
Copy link

Hey @nfx,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: b7032570-e0c4-11ea-a6dd-d374b9ca78b0

@codecov-commenter
Copy link

codecov-commenter commented Aug 18, 2020

Codecov Report

Merging #250 into master will increase coverage by 8.82%.
The diff coverage is 0.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #250      +/-   ##
==========================================
+ Coverage   53.58%   62.41%   +8.82%     
==========================================
  Files          89       53      -36     
  Lines       12201     6263    -5938     
==========================================
- Hits         6538     3909    -2629     
+ Misses       5276     2021    -3255     
+ Partials      387      333      -54     
Flag Coverage Δ
#provider ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
identity/resource_scim_user.go 0.00% <0.00%> (ø)
databricks/data_source_databricks_dbfs_file.go
databricks/resource_databricks_aws_s3_mount.go
databricks/resource_databricks_instance_pool.go
databricks/resource_databricks_mws_workspaces.go
databricks/resource_databricks_job.go
...tabricks/data_source_databricks_dbfs_file_paths.go
databricks/resource_databricks_dbfs_file_sync.go
databricks/data_source_databricks_zones.go
databricks/resource_databricks_cluster.go
... and 27 more

@TravisBuddy
Copy link

Hey @nfx,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: 67e84b40-e133-11ea-a6dd-d374b9ca78b0

@nfx
Copy link
Contributor Author

nfx commented Aug 18, 2020

add deprecation message to each of the gh-pages with re-linking to tf registry & revert github workflow.

@nfx
Copy link
Contributor Author

nfx commented Aug 18, 2020

image
added migration notice

@TravisBuddy
Copy link

Hey @nfx,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: 9e042670-e18a-11ea-81c3-ef1e647c3fbd

notebook_path = "/Production/MakeFeatures"
}

libraries {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stikkireddy i think we'd need one more PR to change libraries to library in jobs & clusters. There's also a bit of resource inconsistency - library blocks logically should be within new_cluster block. though, JAR jobs on existing clusters may think otherwise.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nfx first statement makes sense its awkward to say libraries but only define one. We should make the change before pushing in this release then. The second statement is inaccurate as you can define jobs onto an existing cluster but the jobs can still install libraries. So it does not make sense for library construct to be built into the new_cluster.

@TravisBuddy
Copy link

Hey @nfx,
Your changes look good to me!

View build log

TravisBuddy Request Identifier: b3efe820-e21b-11ea-9f3b-59dd2f7037a2

@nfx nfx merged commit efda279 into master Aug 19, 2020
@nfx nfx deleted the docs-migrate branch August 19, 2020 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants