Skip to content

Commit 42b12c4

Browse files
authored
Remove Quarto website (#63)
* Remove website github workflow * Remove quarto site qmd files * Convert repo docs to markdown * Remove unnecessary make targets
1 parent fd97c9a commit 42b12c4

File tree

9 files changed

+38
-154
lines changed

9 files changed

+38
-154
lines changed

.github/workflows/website.yaml

-48
This file was deleted.

contributing.qmd renamed to CONTRIBUTING.md

+32-48
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,15 @@
1-
---
2-
title: Contributing
3-
---
1+
# Contributing
42

53
Add your extension in the `extensions/` subdirectory.
64

7-
To help you get started, call `make create-extension DIR=my_extension_name` to create a new extension directory with the necessary files. Note, you will need to manually create your `manifest.json` file.
5+
To help you get started, call `make create-extension DIR=my_extension_name` to
6+
create a new extension directory. Note, you will need to manually create your
7+
`manifest.json` file.
88

9-
<br />
9+
## `manifest.json`
1010

11-
## Required files
12-
13-
### `manifest.json`
14-
15-
Use `rsconnect` or `rsconnect-python` to generate a manifest, which is required as part of the extension bundle
16-
17-
### `connect-extension.qmd`
18-
19-
A file that has the name of your extension, the categories it falls into, and a brief description
20-
21-
```{filename="connect-extension.qmd"}
22-
{{< include _template/connect-extension.qmd >}}
23-
```
11+
Use `rsconnect` or `rsconnect-python` to generate a manifest, which is required
12+
as part of the extension bundle.
2413

2514
## Connect Gallery
2615

@@ -41,7 +30,9 @@ in this repository.
4130
Below is an example of the additional details that need to be manually added
4231
to the `manifest.json`:
4332

44-
```json {filename="manifest.json"}
33+
```json
34+
// manifest.json
35+
4536
{
4637
...
4738
"extension": {
@@ -80,7 +71,9 @@ language(s) it utilizes.
8071

8172
Here is an example of what needs to be included in a `manifest.json`:
8273

83-
```json {filename="manifest.json"}
74+
```json
75+
// manifest.json
76+
8477
{
8578
...
8679
"environment": {
@@ -90,8 +83,7 @@ Here is an example of what needs to be included in a `manifest.json`:
9083
"r": {
9184
"requires": ">=4.2, <5"
9285
}
93-
},
94-
...
86+
}
9587
}
9688
```
9789

@@ -110,14 +102,13 @@ To add content to the Connect Gallery, follow the steps below:
110102
"Simple content" refers to content that can be bundled into a TAR file without
111103
any additional steps. Most content will fall into this category.
112104

113-
::: {.callout-note}
114-
If you can run
115-
```bash
116-
tar -czf my-extension-name.tar.gz ./extensions/my-extension-name
117-
```
118-
and the resulting TAR file can be published by uploading the bundle to Posit
119-
Connect, then it is piece of simple content.
120-
:::
105+
> [!NOTE]
106+
> If you can run
107+
> ```bash
108+
> tar -czf my-extension-name.tar.gz ./extensions/my-extension-name
109+
> ```
110+
> and the resulting TAR file can be published by uploading the bundle to Posit
111+
> Connect, then it is piece of simple content.
121112
122113
To add simple content look for the [`simple-extension-changes` section in the `.github/workflows/extensions.yml`](https://github.com/posit-dev/connect-extensions/blob/main/.github/workflows/extensions.yml#L31)
123114
file and add a new filter:
@@ -156,7 +147,7 @@ setting up the environment needed to build the content.
156147
#### Creating a custom workflow
157148
158149
To facilitate control over how the content is being built we utilize custom
159-
GitHub Workflows. See the [Creating a custom workflow](docs/creating-a-custom-workflow.qmd)
150+
GitHub Workflows. See the [Creating a custom workflow](docs/creating-a-custom-workflow.md)
160151
guide how to get started.
161152
162153
#### Calling the custom workflow
@@ -180,7 +171,9 @@ To update already released content in the Connect Gallery simply increment the
180171
`version` field in the `extension` section of the `manifest.json` file and open
181172
a pull request with the changes.
182173
183-
```json {filename="manifest.json"}
174+
```json
175+
// manifest.json
176+
184177
{
185178
...
186179
"extension": {
@@ -201,25 +194,16 @@ you can do that by looking in the GitHub Actions summary. Click on the "Checks"
201194
tab for a Pull Request and then click on the Extension Workflow run and the
202195
summary will be displayed below the workflow graph.
203196
204-
It will either say:
205-
206-
::: {.border}
207-
The manifest version is '1.1.0' and the released version is '1.0.0'
208-
🚀 Will release! The manifest version is greater than the released version.
209-
:::
210-
211-
or:
197+
It will say one of the following based on the `version` in the
198+
`manifest.json` and the last released version:
212199
213-
::: {.border}
214-
The manifest version is '1.0.0' and the released version is '1.0.0'
215-
😴 Holding back from release: The manifest version is not greater than the released version.
216-
:::
200+
> The manifest version is '1.1.0' and the released version is '1.0.0'
201+
> 🚀 Will release! The manifest version is greater than the released version.
217202
218-
or:
203+
> The manifest version is '1.0.0' and the released version is '1.0.0'
204+
> 😴 Holding back from release: The manifest version is not greater than the released version.
219205
220-
::: {.border}
221-
⚠️ Version 0.0.0 is reserved and will never be released.
222-
:::
206+
> ⚠️ Version 0.0.0 is reserved and will never be released.
223207
224208
## Manually testing content
225209

Makefile

-11
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,6 @@ SHELL := /bin/bash
77
.PHONY: FORCE
88
FORCE:
99

10-
# Quarto
11-
docs: FORCE ## [docs] Generate documentation
12-
@echo "📖 Generating documentation"
13-
quarto render
14-
docs-preview: FORCE ## [docs] Watch documentation
15-
@echo "📖 Watching documentation"
16-
quarto preview
17-
1810
# Creating extensions
1911
DIR:=
2012
create-extension: ## [ext] Create extension folder
@@ -36,9 +28,6 @@ create-extension: ## [ext] Create extension folder
3628
@echo "🔧 Creating directory: extensions/$(DIR)"
3729
@mkdir -p "extensions/$(DIR)"
3830

39-
@echo "📝 Copying template files: $(ls -m _template)"
40-
@cp -r _template/* extensions/$(DIR)
41-
4231
@echo ""
4332
@echo "⏳ Remaining Tasks:"
4433
@echo "- [ ] Copy in app files"

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# connect-extensions
1+
# Connect Extensions
22

33
Home for connect extensions
44

55
### Adding Content
66

7-
See the [contributing guide](https://posit-dev.github.io/connect-extensions/contributing.html)
7+
See the [contributing guide](CONTRIBUTING.md)
88
to learn how to contribute content, and add it to the Connect Gallery.

_quarto.yml

-22
This file was deleted.

_template/connect-extension.qmd

-8
This file was deleted.

docs/creating-a-custom-workflow.qmd renamed to docs/creating-a-custom-workflow.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
---
2-
title: Creating a custom workflow
3-
---
1+
# Creating a custom workflow
42

53
Most custom workflows will have common steps. They utilize handy
64
[composite GitHub Actions](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action)
@@ -18,7 +16,9 @@ Replace the `EXTENSION_NAME` variable with your content's name, and add the
1816
custom build steps needed for your content. The custom steps will entirely
1917
depend on your content and what environment it needs to setup.
2018

21-
```yaml {filename=".github/workflows/my-custom-content.yml"}
19+
```yaml
20+
# ./github/workflows/my-custom-content.yml
21+
2222
name: My Custom Content
2323

2424
# Re-usable workflows use the `workflow_call` trigger

extensions.qmd

-6
This file was deleted.

index.qmd

-5
This file was deleted.

0 commit comments

Comments
 (0)