torproject/lego
1
0
Fork 0
mirror of https://github.com/torproject/lego.git synced 2024-11-27 03:30:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
a9c232428d
lego/README.md

51 lines
3.1 KiB
Markdown
Raw Normal View History

Add a README file The README is the start of some helpful documentation, but it's also being used to mark the transition to gitlab as the canonical source for lego. The discussion about that will happen in the MR for this.
2022-01-11 19:46:06 +00:00
# Lego
This repository contains templates, models, assets, databags, and lektor plugins used by many of the lektor sites. It's intended to be added as a submodule, to keep the style and assets up-to-date between sites.
You won't use this repo directly. You'll usually clone it as a submodule:
```
git clone https://gitlab.torproject.org/tpo/web/tpo
cd tpo
git submodule update --init
# or
git clone --recurse-submodules https://gitlab.torproject.org/tpo/web/tpo
```
Add more information about lego Mostly adding lego as a submodule, symlinking, and a brief note about the (lack of a) license.
2022-01-12 20:03:31 +00:00
You might also want to add it to a new lektor project. This is a three-step process:
Add a README file The README is the start of some helpful documentation, but it's also being used to mark the transition to gitlab as the canonical source for lego. The discussion about that will happen in the MR for this.
2022-01-11 19:46:06 +00:00
Add more information about lego Mostly adding lego as a submodule, symlinking, and a brief note about the (lack of a) license.
2022-01-12 20:03:31 +00:00
1. Clone the submodule from the project root: `git submodule add https://gitlab.torproject.org/tpo/web/lego.git`
2. Edit the submodule URL. See <#relative-submodule-urls>.
3. Symlink everything you need. See <#symlinking-lego>.
## Relative submodule URLs
Gitlab CI requires that submodules hosted on the same server as the main repo use relative URLs. If your project isn't hosted on <https://gitlab.torproject.org> or isn't using Gitlab CI, you can skip this!
Relative submodule URLs means that if lego is located at <https://gitlab.torproject.org/tpo/web/lego> and your project is `https://gitlab.torproject.org/tpo/web/some_website`, then your submodule URL should be `../lego.git` **The .git suffix is required**. If your project is hosted in your own namespace (like a fork), your repo URL should look like `https://gitlab.torproject.org/user/repo` your submodule URL should be `../../tpo/web/lego.git`. This means that forking requires you to change your submodule URL to use CI. This is a known bug with upstream gitlab <https://gitlab.com/gitlab-org/gitlab-runner/-/issues/3374> and TPA is looking into solutions in the meantime.
## Symlinking lego
Adding lego as a submodule doesn't actually do anything on its own. You'll need to symlink the parts of lego that you want. For instance, lektor installs all the python packages in `/packages`. Symlinking `/lego/packages` to `/packages` means lektor will install all the packages lego comes with. You can even pick and choose what packages get symlinked: `mkdir -p packages && ln -s ../lego/lektor-md-tag ../lego/npm-support packages`
A list of things contained in lego and descriptions of them is <#package-may-contain>. Usually, you'll want to symlink `/lego/assets/*` to `/assets`, `/lego/templates/*` to `/templates`, `/lego/databags/*` to `/databags*`, and the entire `/lego/packages` directory to `/packages`
Add a README file The README is the start of some helpful documentation, but it's also being used to mark the transition to gitlab as the canonical source for lego. The discussion about that will happen in the MR for this.
2022-01-11 19:46:06 +00:00
## Package may contain
Here's what's inside lego:
* `assets/`
* `assets/javascript/`: Contains the javascript used by bootstrap
* `assets/scss/`: Contains the SCSS for lego. This is Bootstrap v4, with our own styles layered on top
* `assets/static/`: Contains fonts, images, and minified bootstrap js, as well as the compiled SCSS output
* `databags/`: All the databags used by the lego templates
* `models/`: Contains a model for redirect pages
* `packages/`: A number of mirrored and patched python packages. See each package's README for details
* `templates/`: Useful templates used by several of the sites
Add more information about lego Mostly adding lego as a submodule, symlinking, and a brief note about the (lack of a) license.
2022-01-12 20:03:31 +00:00
## License
**TBD**
Lego (and all of TPO's web projects unless otherwise specified) do not yet have a license.
Reference in New Issue Copy Permalink