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

Website upgrade #1503

Merged
merged 2 commits into from
Jan 24, 2024
Merged
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
20 changes: 18 additions & 2 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require('prism-react-renderer/themes/palenight')
const { themes } = require('prism-react-renderer')
const lightCodeTheme = themes.palenight

/** @type {import('@docusaurus/types').Config} */
const config = {
Expand Down Expand Up @@ -39,7 +40,17 @@ const config = {
// Remove this to remove the "edit this page" links.
editUrl: 'https://github.com/boostercloud/booster/tree/main/website/',
},
blog: false,
blog: {
path: 'proposals',
exclude: ['README.md'],
sortPosts: 'ascending',
blogTitle: 'BEEP',
blogDescription: 'Booster Evolution Enhancement Proposals',
blogSidebarTitle: 'Proposals Index',
blogSidebarCount: 'ALL',
editUrl: ({ locale, blogDirPath, blogPath, permalink }) =>
`https://github.com/boostercloud/booster/edit/main/website/proposals/${blogPath}`,
},
theme: {
customCss: [require.resolve('./src/custom.css')],
},
Expand Down Expand Up @@ -68,6 +79,11 @@ const config = {
position: 'left',
label: 'Docs',
},
{
to: 'blog',
label: 'Proposals',
position: 'left',
},
{
href: 'https://github.com/boostercloud/booster',
label: 'GitHub',
Expand Down
33,315 changes: 11,049 additions & 22,266 deletions website/package-lock.json

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,28 @@
"typecheck": "tsc"
},
"dependencies": {
"@apollo/client": "^3.7.8",
"@docusaurus/core": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"@mdx-js/react": "^1.6.22",
"autoprefixer": "^10.4.13",
"clsx": "^1.2.1",
"@apollo/client": "^3.8.10",
"@docusaurus/core": "^3.1.0",
"@docusaurus/preset-classic": "^3.1.0",
"@mdx-js/react": "^3.0.0",
"autoprefixer": "^10.4.17",
"clsx": "^2.1.0",
"docusaurus-plugin-fathom": "^1.2.0",
"fathom-client": "^3.5.0",
"fathom-client": "^3.6.0",
"graphql": "^16.8.1",
"graphql-ws": "^5.11.3",
"postcss": "^8.4.31",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react-markdown": "^8.0.5",
"graphql-ws": "^5.14.3",
"postcss": "^8.4.33",
"prism-react-renderer": "^2.3.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-markdown": "^9.0.1",
"react-modal": "^3.16.1",
"subscriptions-transport-ws": "^0.11.0",
"tailwindcss": "^3.2.4"
"tailwindcss": "^3.4.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.4.0",
"@tsconfig/docusaurus": "^1.0.5",
"@docusaurus/module-type-aliases": "^3.1.0",
"@tsconfig/docusaurus": "^2.0.2",
"typescript": "^4.7.4"
},
"browserslist": {
Expand Down
14 changes: 14 additions & 0 deletions website/proposals/0000-index/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: BEEP 0 - Index of Booster Evolution Enhancement Proposals
authors: [NickSeagull]
date: 2024-01-24T00:00
---

:::caution STATUS - DRAFT
:::

This BEEP will contain the index of all **Booster Evolution Enhancement Proposals**, known as BEEPs. BEEP numbers are assigned by the BEEP editors, and once assigned are never changed.

In the future, the BEEPs will be listed here by category. For now, use the sidebar on the left.

A good starting point is [BEEP 1](./0001-purpose-and-guidelines), which describes the BEEP process itself.
56 changes: 56 additions & 0 deletions website/proposals/0001-purpose-and-guidelines/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: BEEP 1 - Purpose and Guidelines
authors: [NickSeagull]
date: 2024-01-24T00:01
---

:::info STATUS - IN PROGRESS
:::

## What is a BEEP?

BEEP stands for Booster Evolution Enhancement Proposal. It is a document that describes a change or addition to Booster.

## Statuses of a BEEP

A BEEP can have one of the following statuses:

:::caution STATUS - DRAFT
This status indicates that the BEEP is still being written and is not ready for review.
:::

:::info STATUS - IN PROGRESS
This status indicates that the BEEP has been accepted but is still being implemented.
:::

:::tip STATUS - INTEGRATED
This status indicates that the BEEP has been implemented.
:::

:::tip STATUS - ACCEPTED
This status is for informational BEEPs that have been accepted.
:::

:::danger STATUS - REJECTED
This status indicates that the BEEP has been rejected.
:::

## How to contribute to the design process

Everyone is welcome to propose, discuss, and review ideas to improve Booster in the `#proposals` channel of the Discord server.

Note that the project is in a very early stage, and the contribution to the design process is not well defined.

As some general rules for now, take this into account before submitting a proposal:

- No "What about if Booster does a 180-degree turn and instead does this completely unrelated thing?". These kinds of proposals are **seen as completely out of the scope of the Booster project and will be instantly dismissed.**
- **Use constructive criticism.** Instead of "remove this, I don't like it", take a moment to think and give actual reasons like "I believe that this function in the standard library is not clear enough, someone could understand this in a wrong way"
- Is the problem being addressed **impactful enough** to warrant a change to Booster?
- How does this impact the [**Principle of Least Astonishment**](https://en.wikipedia.org/wiki/Principle_of_least_astonishment) of the project?
- How does this impact the [**Principle of Developer Happiness**](https://www.forbes.com/sites/forbestechcouncil/2023/09/22/ensuring-developer-happiness-how-to-hang-on-to-software-engineers) of the project?
- How does this impact the [**Principle of Least Effort**](https://simplicable.com/design/principle-of-least-effort) of the project? Both externally for the users and internally for the maintainers.
- Does this proposal fit well with the **feel and direction** of Booster?
- What **other libraries/languages** got you inspired to submit this proposal? How does this compare to those?
- How much **effort** did you put into your review? A glance, a quick reading, or an in-depth study?

Please **state explicitly** whether you believe that the proposal should be accepted into Booster.
Empty file added website/proposals/README.md
Empty file.
5 changes: 5 additions & 0 deletions website/proposals/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
NickSeagull:
name: Nick Tchayka
title: Booster Core Team
url: https://github.com/NickSeagull
image_url: https://github.com/NickSeagull.png
4 changes: 1 addition & 3 deletions website/src/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
@import './styles/index.css';

:root, * {
font-family: 'IamwriterquattroS';
--ifm-font-family-base: 'IamwriterquattroS';
--ifm-link-color: #00f;
--ifm-color-primary: #0000ff;
--ifm-color-primary-dark: #0000e6;
Expand Down Expand Up @@ -67,7 +65,7 @@
border-radius: 50%;
}

.bc-searchbar {
.bc-searchbar {
display: flex;
gap: 1rem;
padding: 1rem;
Expand Down
2 changes: 2 additions & 0 deletions website/src/fonts.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
@import url('https://fonts.googleapis.com/css2?family=JetBrains+Mono&display=swap');

@font-face {
font-family: IamwriterquattroS;
src: url(/fonts/iAWriterQuattroSRegular.ttf) format("truetype");
Expand Down
7 changes: 6 additions & 1 deletion website/tailwind.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@ module.exports = {
content: ['./src/**/*.{js,jsx,ts,tsx}'],
theme: {
container: false,
extend: {},
extend: {
fontFamily: {
sans: ['IamwriterquattroS', 'sans-serif'],
mono: ['Jetbrains Mono', 'monospace'],
},
},
},
plugins: [],
}