The front door to everything OpenINF makes
The source of the OpenINF portal: the community website, the news archive, the OpenINF SDK reference documentation, and the style handbook. One Eleventy build serves them all.
The portal is in its infancy, so expect gaps and rough edges. Finding one is a good reason to open a pull request.
Open the repository in the dev container and the toolchain is already installed. Otherwise, install Node and pnpm at the versions package.json pins.
pnpm install
pnpm startpnpm start prints the address to open, and rebuilds as you edit. pnpm build
makes a production build, and pnpm test runs the checks a pull request has to
pass.
| Path | What is there |
|---|---|
collections/_pages/ |
Home, about, docs, and news pages |
collections/_posts/ |
The news archive, one file per entry |
collections/_docs/ |
Documentation, and the style handbook |
_layouts/, _includes/ |
Liquid templates and partials |
_assets/ |
Sass, browser JavaScript, and images |
build/ |
The build and verify tasks |
The code of conduct, contributing guide, security policy, and support document are not edited here. They come from OpenINF/.github as the site builds.
Pull requests are welcome. A typo fix needs no ceremony; anything larger is worth an issue first, so nobody writes the same change twice.
Two documents are worth reading beforehand: the contributing guide, and the style handbook, which covers prose, code samples, and commit messages.
If you spot something to fix but cannot patch it yourself, open an issue.
| What | License |
|---|---|
| Source code | MIT OR Apache-2.0 OR BlueOak-1.0.0 |
| OpenINF SDK reference docs | CC BY-NC-SA 4.0 |
| Code samples inside those docs | 0BSD |
| Style handbook | CC BY-SA 4.0 |
Read the license that applies before reusing anything here, because source,
docs, and the handbook do not share one. Source files name theirs in an
@license tag, and the docs and the handbook each keep the full text beside
them.
