chore: rename docs to _docs, tools to _tools (#408)

The go toolchain ignores directories starting with `_` and `.` as well as those named `testdata`. We rename the documentation rool to `_docs` so that it is not considered as part of the distribution package for the root module. The same treatment is applied to `tools` for good measure. Fixes #406
DataDog · Nov 20, 2024 · 4623562 · 4623562
1 parent 49288e7
commit 4623562
Show file tree

Hide file tree

Showing 49 changed files with 17 additions and 17 deletions.
diff --git a/.github/workflows/deps-update.yml b/.github/workflows/deps-update.yml
@@ -53,7 +53,7 @@ jobs:
 
       - name: Update LICENSE-3rdparty.csv
         if: steps.is-tree-dirty.outputs.result == 'true'
-        run: ./tools/make-licenses.sh
+        run: ./_tools/make-licenses.sh
         env:
           TMPDIR: ${{ runner.temp }}
 

diff --git a/.github/workflows/docsite.yml b/.github/workflows/docsite.yml
@@ -33,12 +33,12 @@ jobs:
         # Set environment to anything other than "production", as the theme we use adds SRI attributes to all CSS files,
         # but datadoghq.dev is behind CloudFlare with auto-minify enabled; which breaks SRI if its minification is not
         # identical to hugo's.
-        run: go -C ./docs run github.com/gohugoio/hugo --minify --enableGitInfo --environment=gh-pages
+        run: go -C ./_docs run github.com/gohugoio/hugo --minify --enableGitInfo --environment=gh-pages
       - name: Upload Artifact
         uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4
         with:
           name: site
-          path: docs/public/
+          path: _docs/public/
           if-no-files-found: error
 
   publish:
@@ -60,13 +60,13 @@ jobs:
         uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
         with:
           name: site
-          path: docs/public/
+          path: _docs/public/
       - name: Setup Pages
         uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5
       - name: Upload Pages Artifact
         uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
         with:
-          path: docs/public/
+          path: _docs/public/
       - name: Deploy to Github Pages
         id: deployment
         uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -72,7 +72,7 @@ jobs:
         run: find . -iname go.mod -execdir go mod tidy \;
 
       - name: Refresh LICENSE-3rdparty.csv
-        run: ./tools/make-licenses.sh
+        run: ./_tools/make-licenses.sh
         env:
           TMPDIR: ${{ runner.temp }}
 
@@ -155,7 +155,7 @@ jobs:
           version: v1.60.3
           working-directory: _integration-tests
       - name: Verify license headers
-        run: go run tools/headercheck/header_check.go
+        run: go run ./_tools/headercheck/header_check.go
       - name: vet
         run: go vet ./...
 

diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,3 @@
 [submodule "docs/themes/hextra"]
-	path = docs/themes/hextra
+	path = _docs/themes/hextra
 	url = https://github.com/imfing/hextra.git
diff --git a/docs/.gitattributes → _docs/.gitattributes b/docs/.gitattributes → _docs/.gitattributes
diff --git a/docs/.gitignore → _docs/.gitignore b/docs/.gitignore → _docs/.gitignore
diff --git a/docs/assets/css/custom.css → _docs/assets/css/custom.css b/docs/assets/css/custom.css → _docs/assets/css/custom.css
diff --git a/docs/config/_default/hugo.toml → _docs/config/_default/hugo.toml b/docs/config/_default/hugo.toml → _docs/config/_default/hugo.toml
@@ -51,7 +51,7 @@ dateFormat = '2006-02-01'
 
 [params.editURL]
 enable = true
-base = 'https://github.com/DataDog/orchestrion/edit/main/docs/content'
+base = 'https://github.com/DataDog/orchestrion/edit/main/_docs/content'
 
 [params.footer]
 displayCopyright = true

diff --git a/docs/content/_index.md → _docs/content/_index.md b/docs/content/_index.md → _docs/content/_index.md
diff --git a/docs/content/contributing/_index.md → _docs/content/contributing/_index.md b/docs/content/contributing/_index.md → _docs/content/contributing/_index.md
diff --git a/docs/content/contributing/aspects/_index.md → _docs/content/contributing/aspects/_index.md b/docs/content/contributing/aspects/_index.md → _docs/content/contributing/aspects/_index.md
diff --git a/...nt/contributing/aspects/code-templates.md → ...nt/contributing/aspects/code-templates.md b/...nt/contributing/aspects/code-templates.md → ...nt/contributing/aspects/code-templates.md
diff --git a/...ontent/contributing/aspects/guidelines.md → ...ontent/contributing/aspects/guidelines.md b/...ontent/contributing/aspects/guidelines.md → ...ontent/contributing/aspects/guidelines.md
diff --git a/docs/content/contributing/introduction.md → _docs/content/contributing/introduction.md b/docs/content/contributing/introduction.md → _docs/content/contributing/introduction.md
diff --git a/docs/content/contributing/performance.md → _docs/content/contributing/performance.md b/docs/content/contributing/performance.md → _docs/content/contributing/performance.md
diff --git a/docs/content/docs/_index.md → _docs/content/docs/_index.md b/docs/content/docs/_index.md → _docs/content/docs/_index.md
diff --git a/docs/content/docs/built-in/_index.md → _docs/content/docs/built-in/_index.md b/docs/content/docs/built-in/_index.md → _docs/content/docs/built-in/_index.md
diff --git a/docs/content/docs/custom-trace.md → _docs/content/docs/custom-trace.md b/docs/content/docs/custom-trace.md → _docs/content/docs/custom-trace.md
diff --git a/docs/content/docs/features.md → _docs/content/docs/features.md b/docs/content/docs/features.md → _docs/content/docs/features.md
diff --git a/docs/content/docs/getting-started.md → _docs/content/docs/getting-started.md b/docs/content/docs/getting-started.md → _docs/content/docs/getting-started.md
diff --git a/docs/content/docs/troubleshooting.md → _docs/content/docs/troubleshooting.md b/docs/content/docs/troubleshooting.md → _docs/content/docs/troubleshooting.md
diff --git a/docs/i18n/en.toml → _docs/i18n/en.toml b/docs/i18n/en.toml → _docs/i18n/en.toml
diff --git a/docs/layouts/partials/navbar.html → _docs/layouts/partials/navbar.html b/docs/layouts/partials/navbar.html → _docs/layouts/partials/navbar.html
diff --git a/docs/layouts/partials/scripts.html → _docs/layouts/partials/scripts.html b/docs/layouts/partials/scripts.html → _docs/layouts/partials/scripts.html
diff --git a/docs/layouts/shortcodes/godoc.html → _docs/layouts/shortcodes/godoc.html b/docs/layouts/shortcodes/godoc.html → _docs/layouts/shortcodes/godoc.html
diff --git a/docs/layouts/shortcodes/iconSVG.html → _docs/layouts/shortcodes/iconSVG.html b/docs/layouts/shortcodes/iconSVG.html → _docs/layouts/shortcodes/iconSVG.html
diff --git a/docs/layouts/shortcodes/menu.html → _docs/layouts/shortcodes/menu.html b/docs/layouts/shortcodes/menu.html → _docs/layouts/shortcodes/menu.html
diff --git a/docs/serve.sh → _docs/serve.sh b/docs/serve.sh → _docs/serve.sh
diff --git a/docs/static/android-chrome-192x192.png → _docs/static/android-chrome-192x192.png b/docs/static/android-chrome-192x192.png → _docs/static/android-chrome-192x192.png
diff --git a/docs/static/apple-touch-icon.png → _docs/static/apple-touch-icon.png b/docs/static/apple-touch-icon.png → _docs/static/apple-touch-icon.png
diff --git a/docs/static/favicon-16x16.png → _docs/static/favicon-16x16.png b/docs/static/favicon-16x16.png → _docs/static/favicon-16x16.png
diff --git a/docs/static/favicon-32x32.png → _docs/static/favicon-32x32.png b/docs/static/favicon-32x32.png → _docs/static/favicon-32x32.png
diff --git a/docs/static/favicon.ico → _docs/static/favicon.ico b/docs/static/favicon.ico → _docs/static/favicon.ico
diff --git a/docs/static/images/logo-dark.png → _docs/static/images/logo-dark.png b/docs/static/images/logo-dark.png → _docs/static/images/logo-dark.png
diff --git a/docs/static/images/logo.png → _docs/static/images/logo.png b/docs/static/images/logo.png → _docs/static/images/logo.png
diff --git a/docs/static/schema.json → _docs/static/schema.json b/docs/static/schema.json → _docs/static/schema.json
diff --git a/docs/static/site.webmanifest → _docs/static/site.webmanifest b/docs/static/site.webmanifest → _docs/static/site.webmanifest
diff --git a/docs/themes/hextra → _docs/themes/hextra b/docs/themes/hextra → _docs/themes/hextra
diff --git a/tools/copyrights/merge.go → _tools/copyrights/merge.go b/tools/copyrights/merge.go → _tools/copyrights/merge.go
diff --git a/tools/headercheck/header_check.go → _tools/headercheck/header_check.go b/tools/headercheck/header_check.go → _tools/headercheck/header_check.go
diff --git a/tools/licenses.tpl → _tools/licenses.tpl b/tools/licenses.tpl → _tools/licenses.tpl
diff --git a/tools/make-licenses.sh → _tools/make-licenses.sh b/tools/make-licenses.sh → _tools/make-licenses.sh
@@ -22,8 +22,8 @@ for GOOS in linux darwin windows; do
 
   OUTFILE="${TMPDIR}/LICENSE-3rdparty.${GOOS}.csv"
   echo "Building $(basename "${OUTFILE}")"
-  GOOS="${GOOS}" "${TMPDIR}/bin/go-licenses" report ./... --ignore "${IGNORE_LIST}" --template ./tools/licenses.tpl > "${OUTFILE}" 2> "${TMPDIR}/errors" || (cat "${TMPDIR}/errors" >&2 && exit -1)
+  GOOS="${GOOS}" "${TMPDIR}/bin/go-licenses" report ./... --ignore "${IGNORE_LIST}" --template ./_tools/licenses.tpl > "${OUTFILE}" 2> "${TMPDIR}/errors" || (cat "${TMPDIR}/errors" >&2 && exit -1)
   LICENSE_FILES+=("${OUTFILE}")
 done
 
-go run ./tools/copyrights/merge.go -licenses "${SOURCES}" -output LICENSE-3rdparty.csv "${LICENSE_FILES[@]}"
+go run ./_tools/copyrights/merge.go -licenses "${SOURCES}" -output LICENSE-3rdparty.csv "${LICENSE_FILES[@]}"
diff --git a/tools/verify-licenses.sh → _tools/verify-licenses.sh b/tools/verify-licenses.sh → _tools/verify-licenses.sh
diff --git a/codecov.yml b/codecov.yml
@@ -10,7 +10,7 @@ comment:
 
 ignore:
   - 'samples/**' # This is sample code for instrumentable things
-  - 'tools/**' # Repository maintenance tooling
+  - '_tools/**' # Repository maintenance tooling
   - 'internal/injector/aspect/advice/code/dot_ast.proxies.go' # Auto-generated proxy code
 
 coverage:

diff --git a/instrument/orchestrion.yml b/instrument/orchestrion.yml
@@ -3,7 +3,7 @@
 # This product includes software developed at Datadog (https://www.datadoghq.com/).
 # Copyright 2023-present Datadog, Inc.
 ---
-# yaml-language-server: $schema=../docs/static/schema.json
+# yaml-language-server: $schema=../_docs/static/schema.json
 meta:
   name: github.com/DataDog/orchestrion/instrument
   description: |-

diff --git a/internal/injector/builtin/builtin.go b/internal/injector/builtin/builtin.go
@@ -7,4 +7,4 @@
 // instrumentations.
 package builtin
 
-//go:generate go run ./generator -i=yaml/*.yml -i=yaml/*/*.yml -p=builtin -y=./all.yml -o=./generated.go -d=./generated_deps.go -C=1 -docs=../../../docs/content/docs/built-in/ -schemadocs=../../../docs/content/contributing/aspects/
+//go:generate go run ./generator -i=yaml/*.yml -i=yaml/*/*.yml -p=builtin -y=./all.yml -o=./generated.go -d=./generated_deps.go -C=1 -docs=../../../_docs/content/docs/built-in/ -schemadocs=../../../_docs/content/contributing/aspects/
diff --git a/internal/injector/builtin/generated.go b/internal/injector/builtin/generated.go
diff --git a/internal/injector/builtin/generated_deps.go b/internal/injector/builtin/generated_deps.go
diff --git a/internal/injector/builtin/generator/schema.go b/internal/injector/builtin/generator/schema.go
@@ -150,7 +150,7 @@ func validateSchema(data []byte) error {
 
 func init() {
 	_, thisFile, _, _ := runtime.Caller(0)
-	schemaFile := filepath.Join(thisFile, "..", "..", "..", "..", "..", "docs", "static", "schema.json")
+	schemaFile := filepath.Join(thisFile, "..", "..", "..", "..", "..", "_docs", "static", "schema.json")
 
 	file, err := os.Open(schemaFile)
 	if err != nil {