Skip to content
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.

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

organization documentation #45

Open
wants to merge 21 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 10 additions & 4 deletions .github/workflows/deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ jobs:
env:
ASTRO_STUDIO_APP_TOKEN: ${{ secrets.ASTRO_STUDIO_APP_TOKEN }}
MOONBASE_SECRET_KEY: ${{ secrets.MOONBASE_SECRET_KEY }}
PROTO_LOG: trace
PROTO_NPM_VERSION: "*"
- uses: moonrepo/run-report-action@0e591adc3fbc65a5c9b2f4738368f378c2efaa79 # v1.8.0
if: ${{ steps.moon-build.outputs.skip != 'true' }}
with:
Expand Down Expand Up @@ -161,13 +163,15 @@ jobs:
# If github-token is specified, this is the run that artifacts will be downloaded from.
# Optional. Default is ${{ github.run_id }}
# run-id:
- uses: cloudflare/wrangler-action@a08dc762e87e8754e0d56a16a35a70b406bc869f # v3.6.1
- uses: cloudflare/wrangler-action@f84a562284fc78278ff9052435d9526f9c718361 # v3.7.0
id: wrangler
env:
PROTO_NPM_VERSION: "*"
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
# renovate: datasource=npm depName=wrangler
wranglerVersion: "3.62.0"
wranglerVersion: "3.68.0"
workingDirectory: "apps/site"
packageManager: pnpm
command: pages deploy dist --project-name astrolicious
Expand Down Expand Up @@ -249,13 +253,15 @@ jobs:
# If github-token is specified, this is the run that artifacts will be downloaded from.
# Optional. Default is ${{ github.run_id }}
# run-id:
- uses: cloudflare/wrangler-action@a08dc762e87e8754e0d56a16a35a70b406bc869f # v3.6.1
- uses: cloudflare/wrangler-action@f84a562284fc78278ff9052435d9526f9c718361 # v3.7.0
id: wrangler
env:
PROTO_NPM_VERSION: "*"
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
# renovate: datasource=npm depName=wrangler
wranglerVersion: "3.62.0"
wranglerVersion: "3.68.0"
workingDirectory: "apps/site"
packageManager: pnpm
command: pages deploy dist --project-name astrolicious
Expand Down
2 changes: 1 addition & 1 deletion .moon/toolchain.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
node:
packageManager: pnpm
addEnginesConstraint: true
addEnginesConstraint: false
dedupeOnLockfileChange: true
dependencyVersionFormat: workspace
inferTasksFromScripts: false
Expand Down
2 changes: 1 addition & 1 deletion .node-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
20.15.1
20.16.0
8 changes: 5 additions & 3 deletions .prototools
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# renovate: datasource=github-tags depName=moonrepo/moon
moon = "1.26.7"
moon = "1.27.5"
# renovate: datasource=node-version depName=node versioning=node
node = "20.15.1"
node = "20.16.0"
# renovate: datasource=npm depName=pnpm
pnpm = "9.4.0"
pnpm = "9.6.0"
# renovate: datasource=npm depName=npm
npm = "10.8.2"

[plugins]
moon = "source:https://raw.githubusercontent.com/moonrepo/moon/master/proto-plugin.toml"
8 changes: 7 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,11 @@
},
"[astro]": {
"editor.defaultFormatter": "astro-build.astro-vscode"
}
},
"json.schemas": [
{
"fileMatch": ["/apps/site/src/content/friends/**"],
"url": "./apps/site/.astro/collections/friends.schema.json"
}
]
}
30 changes: 27 additions & 3 deletions apps/site/astro.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { defineConfig } from 'astro/config';

import { resolve } from 'node:path';
import cloudflare from '@astrojs/cloudflare';
import db from '@astrojs/db';
import starlight from '@astrojs/starlight';
import tailwind from '@astrojs/tailwind';
import icon from 'astro-icon';
Expand All @@ -27,17 +26,42 @@ export default defineConfig({
directRenderScript: true,
},
integrations: [
db(),
starlight({
title: 'Astrolicious',
customCss: ['./src/styles/starlight.css'],
favicon: '/favicon.png',
favicon: '/favicon.svg',
components: {
Head: './src/components/starlight/StarlightHead.astro',
Header: './src/components/starlight/StarlightHeader.astro',
Sidebar: './src/components/starlight/StarlightSidebar.astro',
Footer: './src/components/starlight/StarlightFooter.astro',
},
sidebar: [
{ label: 'Welcome', link: '/docs' },
{
label: 'Why Astrolicious?',
badge: {
text: 'New',
},
link: '/blog/why-astrolicious',
},
// {
// label: 'Governance',
// link: '/docs/governance',
// },
// {
// label: 'Guidebook',
// autogenerate: { directory: 'docs/guidebook' },
// },
// {
// label: 'Workflows',
// autogenerate: { directory: 'docs/workflows' },
// },
// {
// label: 'Brand',
// link: '/docs/brand',
// },
],
}),
tailwind({
applyBaseStyles: false,
Expand Down
17 changes: 0 additions & 17 deletions apps/site/db/config.ts

This file was deleted.

6 changes: 4 additions & 2 deletions apps/site/moon.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ fileGroups:
- "package.json"
- "astro.config.ts"
- "wrangler.toml"
- "/pnpm-lock.yaml"
- "/.prototools"
tests:
- "tests/**/*"

Expand All @@ -30,7 +32,7 @@ tasks:
- "@group(sources)"

imports:
command: "biome check --apply --formatter-enabled=false --linter-enabled=false ./"
command: "biome check --write --formatter-enabled=false --linter-enabled=false ./"
inputs:
- "@group(sources)"

Expand All @@ -44,7 +46,7 @@ tasks:
lint:
deps:
- "~:format"
command: "biome lint --apply ./"
command: "biome lint --write ./"
inputs:
- "@group(sources)"

Expand Down
10 changes: 4 additions & 6 deletions apps/site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@
"private": true,
"dependencies": {
"@astrojs/check": "0.7.0",
"@astrojs/cloudflare": "11.0.1",
"@astrojs/db": "0.11.7",
"@astrojs/starlight": "0.24.5",
"@astrojs/cloudflare": "11.0.3",
"@astrojs/starlight": "0.25.3",
"@astrojs/starlight-tailwind": "2.0.3",
"@astrojs/tailwind": "5.1.0",
"@fontsource-variable/dosis": "5.0.20",
Expand All @@ -16,16 +15,15 @@
"@iconify-json/ri": "1.1.21",
"@tailwindcss/forms": "0.5.7",
"@tailwindcss/typography": "0.5.13",
"astro": "4.11.6",
"astro": "4.13.1",
"astro-icon": "1.1.0",
"sanitize-html": "2.13.0",
"simple-stack-form": "0.1.12",
"tailwindcss": "3.4.6",
"zod": "3.23.8"
},
"devDependencies": {
"@types/sanitize-html": "2.11.0",
"wrangler": "3.62.0"
"wrangler": "3.68.0"
},
"scripts": {
"astro": "astro"
Expand Down
Binary file removed apps/site/public/favicon.png
Binary file not shown.
Binary file removed apps/site/public/hero.png
Binary file not shown.
32 changes: 32 additions & 0 deletions apps/site/src/components/FriendCard.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
import type { CollectionEntry } from "astro:content";

interface Props {
friend: CollectionEntry<"friends">;
class?: string;
}

const { friend, class: className } = Astro.props;
const { name, logo, url, slogan } = friend.data;
---

<div
class:list={[
"bg-white p-4 rounded-2xl border border-gray-200 shadow-sm relative",
className,
]}
>
<a href={url} class="grid grid-cols-[1fr_2fr] items-center gap-[1ch]">
<div class="flex justify-center items-center">
<img class="w-20 h-20 object-contain" src={logo} alt={name + " logo"} />
</div>
<h2
class="font-extrabold uppercase text-2xl text-primary-950 max-w-2xl font-heading text-balance"
>
{name}
</h2>
<div class="mt-2 text-gray-700 col-[span_2] text-pretty">
{slogan ?? ""}
</div>
</a>
</div>
11 changes: 11 additions & 0 deletions apps/site/src/content/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,19 @@ const projectsCollection = defineCollection({
}),
});

const friendsCollection = defineCollection({
type: 'data',
schema: z.object({
name: z.string(),
logo: z.string().url(),
url: z.string().url(),
slogan: z.string().optional(),
}),
});

export const collections = {
blog: blogCollection,
docs: docsCollection,
projects: projectsCollection,
friends: friendsCollection,
};
3 changes: 3 additions & 0 deletions apps/site/src/content/docs/docs/brand.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Brand Guidelines
---
69 changes: 69 additions & 0 deletions apps/site/src/content/docs/docs/governance.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
title: Governance
---

This document outlines the governance structure for _**Astrolicious**_.

**All community members must follow the [Code of Conduct (CoC)](https://github.com/astrolicious/.github/blob/main/.github/CODE_OF_CONDUCT.md).**
Consequences for CoC violations are detailed in [Moderation](#moderation).

**Want to trigger a vote, nomiation, or perform some other action?**
Scroll down to [Playbook](#playbook).

## Mission

_**Astrolicious**_ is an independent community organization, unaffiliated with the official Astro project or its maintainers. Our mission is to harness the collective power and creativity of our community to build and maintain a suite of resources, tools, and extensions that complement and enhance the wider ecosystem surrounding Astro. By bringing together community-driven contributions, we aim to facilitate a collaborative environment where individuals can contribute, learn, and benefit from a larger pool of shared knowledge and tools. Our goal is to foster innovation, support the growth of all contributors, and create a robust foundation that enables our community to thrive alongside the evolving landscape of web development. We are committed to inclusivity, open collaboration, and the shared success of our members, independent of, yet respectful to, the Astro project and its goals.

## Roles

We recognize different levels of contribution as roles within the community. Each level comes with a new set of privileges and responsibilities.

All roles are available to all members of the Astrolicious community, regardless of coding skill or experience.

### Contributor

Have you done something (big or small) to contribute to the health, success, or growth of Astrolicious? Congratulations, you're officially recognized as a contributor to the project!

### Triage

Triage roles

### Maintainer

## Special Roles

### Enthusiasts

Engaged members passionate about the project, acting as community ambassadors without participating in decision-making. They represent the community externally. Enthusiast' responsibilities are not funded, though they may receive funding for other roles.

### Masterminds

Known also as the "Board" or "Technical Steering Committee," they are the decision-making core, ensuring the project's and community's health. Masterminds oversee organizational decisions, affecting integrated projects but not standalone ones due to their independent nature. Mastermind' responsibilities are not funded, though they may receive funding for other roles.

### Stewards

The pinnacle role overseeing the project's overall well-being, inclusivity, and sustainability. They prevent the project from being dominated by single entities. Stewards' responsibilities are not funded, though they may receive funding for other roles.

## Standalone Project' Roles
Project maintainers with autonomy to maintain projects in line with established decisions and directions. They are eligible for optional funding based on time, activity commitments and fund availability.

## Retiring a Role (Alumni)

Roles are granted for as long as the person wishes to engage with the project. However, over time an active community member may choose to step away from the project to work on other things. Moving on from a project is a natural and well-understood part of any open source community, and we celebrate it!

**Alumni** is a special designation and role for any person who had once an role assigned but is now no longer actively involved. By retiring and joining Alumni you trade-in your current set of roles, privileges, and responsibilities for a new, special Alumni role (which comes with its own set of Privileges, as described above).

You can retire your role at any time and requesting Alumni status. You can initiate this action yourself if you know ahead-of-time that you need to step away from the project. Or, if you have gone several months without interacting with the community, the project may actively reach out to you to discuss retiring as a way to make room for new members.

As an Alumni member, you are still a part of the community. You may also request to have your old roles reinstated at any time through the normal process for that role.

## Moderation

## Our Playbook
Anything that supports the Astrolicious or Astro community is a valubale contribution.

All types of contribution are meaningful. This can include code, Design, Documentation, Discord activity, and even posting about Astrolicious. No contribution is too small!

Anyone can become an Astrolicious contributor (yes, even you!). Engineering ability is not required. Our goal is to recognize all contributeors to the project regardless of skill, experience, or background.

_Our governance document is inspired by [Astro](https://github.com/withastro/.github/blob/main/GOVERNANCE.md)._
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Community Content
---

add a new json file to astro tips community content collection, which will be automaticly pushed to astro docs, to be visible in the community section of the astro docs.
6 changes: 6 additions & 0 deletions apps/site/src/content/docs/docs/guidebook/cross-posting.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Cross-Posting
---


people can cross-post their content to astrolicious blog or astro tips community section, as long as they reference their own blog adress here and backlink fromt their blog us.
9 changes: 9 additions & 0 deletions apps/site/src/content/docs/docs/guidebook/recipes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Astro Tips Recipes
---

have explanation about recipe and how to create one

inspo:
https://contribute.docs.astro.build/guides/recipe-writing/
https://contribute.docs.astro.build/guides/new-third-party-stub/
5 changes: 5 additions & 0 deletions apps/site/src/content/docs/docs/guidebook/tips.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Astro Tips Tips
---

snippets, very short tutorials, etc.
Loading