documentation

This commit is contained in:
inherentlee committed 2026-09-25 12:38:36 -07:00
1 parent 6f112ca4ed
commit fe2d91b0b3
3 files changed
+70 -71

No files matched your search

+66
View File
@@ -0,0 +1,66 @@
# Drone/Submodule setup
## 1. create repo
in heckin gitea, create destination repo.
## 2. update dronefile in source repo
Update the `<placeholder values>` in [.drone.yml](.drone.yml).
## 3. create and add PAT (one-time, not per repo)
in heckin, go to settings > applications, and create a PAT with read & write permissions to repositories.
in drone, you can set your PAT either as a project secret or an organization secret. In either case call it `GIT_TOKEN`.
## 4. activate project in drone
in drone, find your project and activate it.
in the settings, I chose to disable pull requests and forks. I set my runner timeout to 15m.
## 5. first commit to submodule
assuming we are committing the _site folder...
```sh
cp -r _site ../temp
cd ../temp
git init
git add -A
git commit -m "first"
git remote add origin <remote-url>
git push -u origin main
```
then you can delete the temp directory.
## 6. add submodule to local repo
in root dir of local repo, add the submodule.
```sh
git submodule add <remote-url>
```
if you used the SSH url, set it to the HTTPS url.
```sh
git submodule set-url <dest-repo> <remote-url-https>
git add .gitmodules # the changes from submodule add are auto-staged, this config change isn't
```
commit your changes and push.
```sh
git commit -m "add submodule"
```
(commit your dronefile changes too.)
## 7. profit
if it doesn't work, cry
+4 -70
View File
@@ -10,75 +10,9 @@ Always remember to check for changes before starting work, and sync your changes
Please import images in the "Media Library" tab - uploading them directly via post creation seems to create issues with the image pathing. Please import images in the "Media Library" tab - uploading them directly via post creation seems to create issues with the image pathing.
## Nested navigation ## Nested navigation for pages
To create *accessible* nested navigation, make sure to turn the "Permalink" setting under the "Navigation" tab OFF for the top level of the nested section. This ensures that the menu can be clickable to open rather than hover-able. To create more accessible nested navigation:
--- - Create the top level page and turn the "Linkable" setting to OFF (eye with a slash through it)
- Create the lower level pages as normal
## full drone/submodule setup from scratch
### 1. create repo
in heckin gitea, create destination repo.
### 2. update dronefile in source repo
Update the `<placeholder values>` in [.drone.yml](.drone.yml).
### 3. create and add PAT (one-time, not per repo)
in heckin, go to settings > applications, and create a PAT with read & write permissions to repositories.
in drone, you can set your PAT either as a project secret or an organization secret. In either case call it `GIT_TOKEN`.
### 4. activate project in drone
in drone, find your project and activate it.
in the settings, I chose to disable pull requests and forks. I set my runner timeout to 15m.
### 5. first commit to submodule
assuming we are committing the _site folder...
```sh
cp -r _site ../temp
cd ../temp
git init
git add -A
git commit -m "first"
git remote add origin <remote-url>
git push -u origin main
```
then you can delete the temp directory.
### 6. add submodule to local repo
in root dir of local repo, add the submodule.
```sh
git submodule add <remote-url>
```
if you used the SSH url, set it to the HTTPS url.
```sh
git submodule set-url <dest-repo> <remote-url-https>
git add .gitmodules # the changes from submodule add are auto-staged, this config change isn't
```
commit your changes and push.
```sh
git commit -m "add submodule"
```
(commit your dronefile changes too.)
### 7. profit
if it doesn't work, cry
-1
View File
@@ -7,4 +7,3 @@ eleventyNavigation:
___mb_schema: /.mattrbld/schemas/page.json ___mb_schema: /.mattrbld/schemas/page.json
permalink: false permalink: false
--- ---
Here’s some body text