Merge pull request PelicanPlatform#1362 from haoming29/add-contribute

jhiemstrawisc · Jun 3, 2024 · 44992b6 · 44992b6
2 parents 7f359b7 + 285374a
commit 44992b6
Show file tree

Hide file tree

Showing 14 changed files with 393 additions and 1 deletion.
diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
diff --git a/dev/dev_pelican.yaml b/dev/dev_pelican.yaml
@@ -0,0 +1,15 @@
+TLSSkipVerify: true # Turn off the TLS check for developmetn
+Logging:
+  Level: "debug" # Debug level will log more verbose messages
+Federation:
+  DiscoveryUrl: "https://osdf-itb.osg-htc.org" # The federation for testing
+  TopologyNamespaceURL: https://topology.opensciencegrid.org/osdf/namespaces
+Origin:
+  Exports:
+    - StoragePrefix: /tmp/pelican # Export this directory on your machine to the federation
+      FederationPrefix: /<your-name>/test/origin1 # Replace <your-name> to your name! Otherwise the origin may fail to start
+      Capabilities: ["Reads", "PublicReads"]
+Director:
+  MaxMindKeyFile: /workspaces/pelican-dev/MaxMindKey # The location of your MaxMind license key
+Registry:
+  InstitutionsUrl: "https://topology.opensciencegrid.org/institution_ids"
diff --git a/dev/devcontainer.json b/dev/devcontainer.json
@@ -0,0 +1,23 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/cpp
+{
+	"name": "Pelican",
+	"image": "hub.opensciencegrid.org/pelican_platform/pelican-dev:latest-itb",
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"settings": {
+			"go.gopath": "/root/go",
+			"go.goroot": "/usr/local/go",
+			"go.useLanguageServer": true
+		},
+		"extensions": ["golang.go"],
+		"postCreateCommand": "go get -v github.com/go-delve/delve/cmd/dlv"
+	},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	"remoteUser": "root"
+}
diff --git a/docs/images/dev-container-bl-icon.png b/docs/images/dev-container-bl-icon.png
diff --git a/docs/images/dev-container-copy-config.png b/docs/images/dev-container-copy-config.png
diff --git a/docs/images/dev-container-folder.png b/docs/images/dev-container-folder.png
diff --git a/docs/images/dev-container-loading.png b/docs/images/dev-container-loading.png
diff --git a/docs/images/dev-container-reopen.png b/docs/images/dev-container-reopen.png
diff --git a/docs/images/dev-container-status.png b/docs/images/dev-container-status.png
diff --git a/docs/images/dev-container.png b/docs/images/dev-container.png
diff --git a/docs/images/docker-startup.png b/docs/images/docker-startup.png
diff --git a/docs/images/vscode-start-terminal.png b/docs/images/vscode-start-terminal.png
diff --git a/docs/images/vscode-ws-after-config.png b/docs/images/vscode-ws-after-config.png
diff --git a/go.mod b/go.mod
@@ -177,7 +177,7 @@ require (
 	go.opentelemetry.io/otel/trace v1.20.0 // indirect
 	go.uber.org/goleak v1.2.1 // indirect
 	golang.org/x/arch v0.3.0 // indirect
-	golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect
+	golang.org/x/exp v0.0.0-20231006140011-7918f672742d
 	golang.org/x/sync v0.6.0
 	golang.org/x/text v0.14.0
 	golang.org/x/time v0.5.0