Skip to content

Commit

Permalink
Explaining OSS engagement (#5324)
Browse files Browse the repository at this point in the history
  • Loading branch information
tajo authored Dec 20, 2023
1 parent d842c01 commit 3e03277
Show file tree
Hide file tree
Showing 5 changed files with 93 additions and 68 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<h1 align="center">Base Web React Components</h1>

[![Build status](https://badge.buildkite.com/92a7500cd98f619621c4801833d8b358c2fd79efc9b98f1b98.svg?branch=master)](https://buildkite.com/uberopensource/baseui)
⚠️ **Maintenance status**. We are limiting our engagement with this repository while still mirroring our internal development. For more details, please check [Open Source Engagement and Future](https://baseweb.design/blog/open-source-engagement/). If you are an Uber developer and looking to open an issue, use this [link](https://t.uber.com/ui-platform-bug-2) or [contribute](https://p.uber.com/base-code).

**Base** is a design system comprised of modern, responsive, living components. Base Web is the React implementation of Base.

Expand All @@ -31,21 +31,21 @@ npm install baseui styletron-react styletron-engine-monolithic
```

```javascript
import {Client as Styletron} from 'styletron-engine-monolithic';
import {Provider as StyletronProvider} from 'styletron-react';
import {LightTheme, BaseProvider, styled} from 'baseui';
import {StatefulInput} from 'baseui/input';
import { Client as Styletron } from "styletron-engine-monolithic";
import { Provider as StyletronProvider } from "styletron-react";
import { LightTheme, BaseProvider, styled } from "baseui";
import { StatefulInput } from "baseui/input";

const engine = new Styletron();

const Centered = styled('div', {
display: 'flex',
justifyContent: 'center',
alignItems: 'center',
height: '100%',
const Centered = styled("div", {
display: "flex",
justifyContent: "center",
alignItems: "center",
height: "100%",
});

export default function Hello () {
export default function Hello() {
return (
<StyletronProvider value={engine}>
<BaseProvider theme={LightTheme}>
Expand All @@ -62,4 +62,4 @@ Both Base Web and Styletron come with [TypeScript](https://www.typescriptlang.or

## Docs

To read the documentation, please visit [baseweb.design](https://baseweb.design).
To read the documentation, please visit [baseweb.design](https://baseweb.design). To preview more component examples, please visit [baseweb.design/ladle](https://baseweb.design/ladle).
25 changes: 25 additions & 0 deletions documentation-site/pages/blog/open-source-engagement/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import Layout from "../../../components/layout";
import { Meta } from "../../../components/blog";
import metadata from "./metadata.json";

export default Layout;

<Meta data={metadata} />

Our involvement with the open source community has been somewhat limited recently, and we apologize for this. The reality is, we view Base Web as a rather mature project, and our focus has shifted to other areas. Nevertheless, we continue to maintain this library by updating dependencies, addressing bugs, and introducing new features and components. This commitment to Base Web, a foundational element of all Uber's web applications, will persist for years to come.

However, our activity in the open source software community will be less than before. We're no longer actively reviewing and merging pull requests or participating in the issues section. To streamline development, we've integrated Base Web's source code into our internal monorepo, focusing entirely on our internal customers and their specific needs.

# New Versions

We still mirror Base Web's source code in this public repository for visibility and use. Internally, we don't adhere to a versioning system as everyone uses the latest code, so we don't track breaking changes. Moving forward, we plan to publish all main commits of baseui as versions like 0.0.0-next-d12da36, where d12da36 is the commit SHA. This approach allows access to the latest Base Web version, though be aware that breaking changes may not be announced or documented. Occasionally, we might release a new stable major version.

# Community Support

Since we no longer monitor it, we have closed the issue section. However, you're welcome to submit a pull request. If it's highly beneficial internally, we may consider merging it, but be advised that integrating public PRs into our internal monorepo is a substantial effort and may take time.

For ongoing support, there's a large [Base Web Slack channel](https://join.slack.com/t/baseui/shared_invite/zt-5f1s4d10-1D2uywAECAG50m64PTH9cw) with over 1300 members. We encourage you to join and pose your questions there.

# Future

We remain as enthusiastic about Base Web as we were at its inception. It boasts a [unique customization system](/guides/understanding-overrides) that has proven extremely valuable for our internal clients. We continue to develop innovative tools surrounding it, such as employing generative AI to scaffold new UIs using Base Web components. We hope to share more details on this exciting development soon. However, for now, the development of Base Web will be driven by our internal needs, and we'll continue to share our progress with you.
11 changes: 11 additions & 0 deletions documentation-site/pages/blog/open-source-engagement/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"author": "Vojtech Miksu",
"authorLink": "https://github.com/tajo",
"title": "Open Source Engagement and Future",
"tagline": "Let's clarify the future of Base Web and what it means for OSS",
"date": "19 December 2023",
"coverImage": "https://user-images.githubusercontent.com/5317799/160484160-c3de4f21-c4bd-4978-b39a-7c5c677b449f.png",
"coverImageWidth": 960,
"coverImageHeight": 575,
"keyWords": ["Base Web", "Design System", "React", "Changelog"]
}
88 changes: 32 additions & 56 deletions documentation-site/pages/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ LICENSE file in the root directory of this source tree.
import * as React from "react";
import { Block } from "baseui/block";
import { Button } from "baseui/button";
import { Banner } from "baseui/banner";
import { FlexGrid, FlexGridItem } from "baseui/flex-grid";
import { StyledLink as Link } from "baseui/link";
import Markdown, {
H1,
H2,
} from "../components/markdown-elements";
import Markdown, { H1, H2 } from "../components/markdown-elements";
import { Card, StyledBody } from "baseui/card";
import { Tag } from "baseui/tag";
import { withStyle } from "baseui";
Expand Down Expand Up @@ -53,12 +51,7 @@ const Adopters = (props) => (
alignItems="center"
justifyContent="center"
>
<Block
margin="scale200"
width="125px"
as="img"
src={logoSrc}
/>
<Block margin="scale200" width="125px" as="img" src={logoSrc} />
</FlexGridItem>
))}
</FlexGrid>
Expand Down Expand Up @@ -98,18 +91,18 @@ const Index = (props) => (
<Tag kind="positive" closeable={false}>
New
</Tag>
<Block
color="contentPrimary"
display="inline-block"
font="font250"
>
<Block color="contentPrimary" display="inline-block" font="font250">
{BlogPosts[0].title}
</Block>
</Block>
<H1>Base Web React UI framework</H1>
<Banner>
Uber devs, check <a href="https://p.uber.com/basegpt">BaseGPT</a>, an AI
assistant that codes in Base Web.
</Banner>
<Markdown.p>
Base Web is a foundation for initiating, evolving, and
unifying web products.
Base Web is a foundation for initiating, evolving, and unifying web
products.
</Markdown.p>
<Block
display="flex"
Expand All @@ -126,14 +119,10 @@ const Index = (props) => (
},
}}
>
<Card
title="Setup Base Web"
overrides={cardOverrides}
>
<Card title="Setup Base Web" overrides={cardOverrides}>
<MinHeightBody>
Base Web is distributed as an npm package. As Base
Web is built on top of a CSS-in-JS engine, all you
need is the dependencies from npm.
Base Web is distributed as an npm package. As Base Web is built on top
of a CSS-in-JS engine, all you need is the dependencies from npm.
</MinHeightBody>
<Button
$as="a"
Expand All @@ -151,14 +140,10 @@ const Index = (props) => (
</Button>
</Card>

<Card
title="Learning Base Web"
overrides={cardOverrides}
>
<Card title="Learning Base Web" overrides={cardOverrides}>
<MinHeightBody>
The best way to learn Base Web is to start
building an application using it. Click on the
link below to find 2 apps built using Base Web
The best way to learn Base Web is to start building an application
using it. Click on the link below to find 2 apps built using Base Web
(one simple, one more complex).
</MinHeightBody>
<Button
Expand All @@ -179,42 +164,33 @@ const Index = (props) => (
</Block>
<H2>Components</H2>
<Markdown.p>
Base Web offers a robust suite of components out of
the box. These include complex, ready-to-use
components such as{" "}
<Link href="/components/datepicker">Datepicker</Link>{" "}
and low-level composable primitives, such as{" "}
<Link href="/components/layer">Layer</Link>.
Base Web offers a robust suite of components out of the box. These include
complex, ready-to-use components such as{" "}
<Link href="/components/datepicker">Datepicker</Link> and low-level
composable primitives, such as <Link href="/components/layer">Layer</Link>
.
</Markdown.p>
<Markdown.p>
For an overview of everything that we offer, check out
the{` `}
For an overview of everything that we offer, check out the{` `}
<Link href="/components">component gallery</Link>.
</Markdown.p>
<H2>Extensibility</H2>
<Markdown.p>
Through the{" "}
<Link href="/guides/understanding-overrides">
Overrides API
</Link>{" "}
and{" "}
<Link href="/guides/theming">
configurable Themes
</Link>
, Base Web offers an extreme level of customization.
Whether you want to modify a component in one place
only or you want to build your design system on top of
Base Web, we have options.
<Link href="/guides/understanding-overrides">Overrides API</Link> and{" "}
<Link href="/guides/theming">configurable Themes</Link>, Base Web offers
an extreme level of customization. Whether you want to modify a component
in one place only or you want to build your design system on top of Base
Web, we have options.
</Markdown.p>
<H2>Built-in accessibility</H2>
<Markdown.p>
Base Web does the heavy lifting for you—components are
built with accessibility being a first-class citizen.
Base Web does the heavy lifting for you—components are built with
accessibility being a first-class citizen.
</Markdown.p>
<H2>Performance</H2>
<Markdown.p>
Styletron is the CSS-in-JS engine powering Base Web.
Based on{" "}
Styletron is the CSS-in-JS engine powering Base Web. Based on{" "}
<Link href="https://ryantsao.com/blog/virtual-css-with-styletron">
our benchmarks
</Link>
Expand All @@ -226,8 +202,8 @@ const Index = (props) => (
<Link href="https://baseweb.design/blog/base-figma-community/">
Figma Community
</Link>
. This should help your design team adopt Base Web,
while engineers can use the React implementation.
. This should help your design team adopt Base Web, while engineers can
use the React implementation.
</Markdown.p>
<Adopters
logoSrcs={[
Expand Down
13 changes: 13 additions & 0 deletions documentation-site/posts.jsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,17 @@
const posts = [
{
path: "/blog/open-source-engagement",
author: "Vojtech Miksu",
authorLink: "https://github.com/tajo",
title: "Open Source Engagement and Future",
tagline: "Let's clarify the future of Base Web and what it means for OSS",
date: "19 December 2023",
coverImage:
"https://user-images.githubusercontent.com/5317799/160484160-c3de4f21-c4bd-4978-b39a-7c5c677b449f.png",
coverImageWidth: 960,
coverImageHeight: 575,
keyWords: ["Base Web", "Design System", "React", "Changelog"],
},
{
path: "/blog/base-web-v12",
author: "Chase Starr",
Expand Down

0 comments on commit 3e03277

Please sign in to comment.