Thanks to visit codestin.com
Credit goes to github.com

Skip to content

split examples into examples and quickstart #4634

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.

Sign up for GitHub

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

Closed
wants to merge 8 commits into from
Closed

split examples into examples and quickstart #4634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5cf20d6
chore: clean up example templates & add quickstarts
ericpaulsen Oct 3, 2022
a471feb
feat: Allow nesting of directories for examples
Emyrk Oct 3, 2022
40c8e1b
remove prints
Emyrk Oct 3, 2022
edd0aab
Fix imports for example templates
Emyrk Oct 3, 2022
392b23f
change structure
bpmct Oct 18, 2022
bea6c19
build binary with proper templates dir
bpmct Oct 18, 2022
9c526de
use quickstart dir instead
bpmct Oct 18, 2022
de4b3fb
change quickstart dir
bpmct Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ endef
# calling this manually.
$(CODER_ALL_BINARIES): go.mod go.sum \
$(shell find . -not -path './vendor/*' -type f -name '*.go') \
$(shell find ./examples/templates)
$(shell find ./templates/quickstart)

$(get-mode-os-arch-ext)
if [[ "$$os" != "windows" ]] && [[ "$$ext" != "" ]]; then
Expand Down
2 changes: 1 addition & 1 deletion cli/templateinit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import (
"github.com/spf13/cobra"

"github.com/coder/coder/cli/cliui"
"github.com/coder/coder/examples"
"github.com/coder/coder/provisionersdk"
examples "github.com/coder/coder/templates"
)

func templateInit() *cobra.Command {
Expand Down
2 changes: 1 addition & 1 deletion coderd/users.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import (
"github.com/coder/coder/coderd/userpassword"
"github.com/coder/coder/coderd/util/slice"
"github.com/coder/coder/codersdk"
"github.com/coder/coder/examples"
examples "github.com/coder/coder/templates"
Copy link
Member Author

Choose a reason for hiding this comment

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

@ericpaulsen Shouldn't this specifically be the quickstarts folder since this is what we want to show in coder templates init?

Copy link
Member

@ericpaulsen ericpaulsen Oct 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

@bpmct yeah, quickstarts should be referenced when running coder templates init.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we need to change this to only reference the quickstarts since it's used for the autoimport behavior. I might be missing something though?

Copy link
Member Author

Choose a reason for hiding this comment

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

I guess, I'm asking if we should change it to this

quickstart "github.com/coder/coder/templates/quickstart"

)

// Returns whether the initial user has been created or not.
Expand Down
0 examples/lima/README.md → docs/recipes/lima/README.md
View file
Open in desktop
File renamed without changes.
0 examples/lima/coder.yaml → docs/recipes/lima/coder.yaml
View file
Open in desktop
File renamed without changes.
7 changes: 0 additions & 7 deletions examples/templates/bare/README.md
View file
Open in desktop

This file was deleted.

58 changes: 0 additions & 58 deletions examples/templates/bare/main.tf
View file
Open in desktop

This file was deleted.

25 changes: 0 additions & 25 deletions examples/templates/docker-code-server/README.md
View file
Open in desktop

This file was deleted.

78 changes: 0 additions & 78 deletions examples/templates/docker-code-server/main.tf
View file
Open in desktop

This file was deleted.

2 changes: 0 additions & 2 deletions examples/templates/docker-code-server/params.sample.yaml
View file
Open in desktop

This file was deleted.

51 changes: 0 additions & 51 deletions examples/templates/gcp-vm-container/README.md
View file
Open in desktop

This file was deleted.

123 changes: 0 additions & 123 deletions examples/templates/gcp-vm-container/main.tf
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion examples/templates/README.md → templates/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Templates
~# Example templates

List template examples in our CLI with `coder templates init`.

Expand Down
0 examples/templates/community-templates.md → templates/community-templates.md
View file
Open in desktop
File renamed without changes.
Loading