Skip to content

Commit 1cdc1ba

Browse files
mariaob1201claude
mariaob1201
and
claude
committed
Add Apache 2.0 LICENSE, rewrite README, skip deploy for docs-only files
- Add full Apache 2.0 LICENSE (the project is Apache-licensed but had no LICENSE file) - Rewrite README: current repo layout, v1-pinned local preview, contributing/deployment sections, badges - deploy.yml: paths-ignore README.md/CONTRIBUTING.md/LICENSE so docs-only changes no longer trigger a Pages deploy Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent ec2009b commit 1cdc1ba

3 files changed

Lines changed: 275 additions & 29 deletions

File tree

‎.github/workflows/deploy.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ name: Deploy Jupyter Book to GitHub Pages
33
on:
44
push:
55
branches: [ master ]
6+
paths-ignore:
7+
- 'README.md'
8+
- 'CONTRIBUTING.md'
9+
- 'LICENSE'
610

711
permissions:
812
contents: read

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or Derivative
95+
Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2016 The OpenLambda Authors
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 70 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,86 @@
1-
# OpenLambda GitHub Pages — MyST Markdown Site
1+
# OpenLambda Documentation Site
22

3-
This repo deploys automatically to GitHub Pages using [Jupyter Book](https://jupyterbook.org)
4-
with [MyST Markdown](https://myst-parser.readthedocs.io/) as the technical documentation of Open Lambda.
3+
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4+
[![Deploy](https://github.com/open-lambda/open-lambda.github.io/actions/workflows/deploy.yml/badge.svg)](https://github.com/open-lambda/open-lambda.github.io/actions/workflows/deploy.yml)
5+
6+
Source for the **OpenLambda** documentation and blog, published at
7+
**<https://open-lambda.github.io/>**.
8+
9+
The site is built with [Jupyter Book](https://jupyterbook.org) (v1, Sphinx-based) using
10+
[MyST Markdown](https://myst-parser.readthedocs.io/) and the `sphinx_book_theme`, with
11+
[ABlog](https://ablog.readthedocs.io/) powering the blog. Every push to `master` is built
12+
and deployed to GitHub Pages automatically.
13+
14+
> [!NOTE]
15+
> This repo hosts the **website**, not the OpenLambda runtime. For the serverless platform
16+
> itself, see [open-lambda/open-lambda](https://github.com/open-lambda/open-lambda).
517
618
---
719

8-
## File Structure
20+
## Repository layout
921

1022
```
1123
.
12-
├── index.md ← Homepage content (MyST Markdown)
13-
├── _config.yml ← Jupyter Book site settings
14-
├── _toc.yml ← Table of contents (add more pages here)
15-
├── requirements.txt ← Python deps for the build
16-
├── .gitignore
17-
└── .github/
18-
└── workflows/
19-
└── deploy.yml ← GitHub Actions auto-deploy workflow
24+
├── index.md ← Homepage
25+
├── worker.md ← Worker documentation
26+
├── applications/ ← Application case studies
27+
│ ├── index.md
28+
│ └── ag-forecasting-api.md
29+
├── blog/ ← Blog (ABlog)
30+
│ ├── index.md
31+
│ └── post/ ← One file per post: YYYY-MM-DD-slug.md
32+
├── _config.yml ← Jupyter Book / Sphinx settings
33+
├── _toc.yml ← Table of contents (register new pages here)
34+
├── _static/ ← Logo, favicon, and other assets
35+
├── requirements.txt ← Pinned Python build dependencies
36+
├── CONTRIBUTING.md ← How to add pages, posts, and authors
37+
├── LICENSE ← Apache 2.0
38+
└── .github/workflows/
39+
└── deploy.yml ← Build + deploy to GitHub Pages
2040
```
2141

2242
---
2343

24-
## One-Time Setup (do this once per repo)
25-
26-
### 1. Clone the repo and copy these files in
27-
28-
```bash
29-
git clone https://github.com/open-lambda/open-lambda.github.io.git
30-
cd open-lambda.github.io
31-
32-
# Copy all files from this bundle into the repo root, then:
33-
git add .
34-
git commit -m "Add MyST Markdown Jupyter Book site"
35-
git push
36-
```
37-
38-
## Local Preview
44+
## Local preview
3945

4046
```bash
47+
python3 -m venv .venv && source .venv/bin/activate
4148
pip install -r requirements.txt
4249
jupyter-book build .
43-
# Open in browser:
44-
open _build/html/index.html
50+
open _build/html/index.html # macOS; use xdg-open on Linux
4551
```
52+
53+
> [!IMPORTANT]
54+
> Dependencies are pinned to the Jupyter Book **v1** stack. Do **not** bump `jupyter-book`
55+
> to 2.x — v2 is a MyST-CLI rewrite that is incompatible with this repo's `_config.yml`,
56+
> `_toc.yml`, and `sphinx_book_theme` setup.
57+
58+
A successful build ends with `build succeeded.` and writes HTML to `_build/html/`.
59+
60+
---
61+
62+
## Contributing
63+
64+
See [CONTRIBUTING.md](CONTRIBUTING.md) for how to add a documentation page, write a blog
65+
post (front matter, file naming, excerpts), and register a blog author. In short:
66+
67+
- **New page** → add the `.md` file and register it in [`_toc.yml`](_toc.yml).
68+
- **New blog post** → add `blog/post/YYYY-MM-DD-slug.md` with `blogpost: true` front
69+
matter (ABlog collects it automatically — no `_toc.yml` entry needed).
70+
71+
Please run `jupyter-book build .` locally and confirm it succeeds without warnings before
72+
opening a pull request.
73+
74+
---
75+
76+
## Deployment
77+
78+
[`.github/workflows/deploy.yml`](.github/workflows/deploy.yml) builds the book and publishes
79+
`_build/html` to GitHub Pages on every push to `master`. Changes to docs-only files
80+
(`README.md`, `CONTRIBUTING.md`, `LICENSE`) do not trigger a deploy.
81+
82+
---
83+
84+
## License
85+
86+
Licensed under the **Apache License 2.0** — see [LICENSE](LICENSE) for the full text.

0 commit comments

Comments
 (0)