Skip to content

Commit 4897595

Browse files
cecilia-dwacecilia-dwa
committed
Final squash and merge commit for DPEL website
Signed-off-by: Cecilia Tran <cecilia.tran@dreamworks.com> Signed-off-by: Cecilia Tran <cecilia.tran@dreamworks.com>
1 parent 9e649b7 commit 4897595

98 files changed

Lines changed: 11829 additions & 2 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
# Trigger the workflow every time you push to the `main` branch
5+
# Using a different branch name? Replace `main` with your branch’s name
6+
push:
7+
branches: [ main ]
8+
# Allows you to run this workflow manually from the Actions tab on GitHub.
9+
workflow_dispatch:
10+
11+
# Allow this job to clone the repo and create a page deployment
12+
permissions:
13+
contents: read
14+
pages: write
15+
id-token: write
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout your repository using git
22+
uses: actions/checkout@v3
23+
- name: Install, build, and upload your site
24+
uses: withastro/action@v0
25+
# with:
26+
# path: . # The root location of your Astro project inside the repository. (optional)
27+
# node-version: 16 # The specific version of Node that should be used to build your site. Defaults to 16. (optional)
28+
# package-manager: yarn # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
29+
30+
deploy:
31+
needs: build
32+
runs-on: ubuntu-latest
33+
environment:
34+
name: github-pages
35+
url: ${{ steps.deployment.outputs.page_url }}
36+
steps:
37+
- name: Deploy to GitHub Pages
38+
id: deployment
39+
uses: actions/deploy-pages@v1

‎.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

‎.vscode/extensions.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"recommendations": ["astro-build.astro-vscode"],
3+
"unwantedRecommendations": []
4+
}

‎.vscode/launch.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"command": "./node_modules/.bin/astro dev",
6+
"name": "Development server",
7+
"request": "launch",
8+
"type": "node-terminal"
9+
}
10+
]
11+
}

‎README.md‎

Lines changed: 77 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,77 @@
1-
# dpel-website
2-
Website for the Digital Production Example Library
1+
# DPEL Website Doc
2+
3+
**DPEL: Digital Production Example Library**
4+
A library of digital assets - 3D scenes, digital cinema footage, etc. - that demonstrate the scale and complexity of modern feature film production, including computer graphics, visual effects and animation.
5+
6+
## 🚀 Project Structure
7+
8+
Inside the DPEL project, you'll see the following folders and files:
9+
10+
```
11+
/
12+
├── public/
13+
│ └── favicon.svg ( This is the icon that shows up in the browser tab )
14+
│ └── images/ ( All images for the site is stored here )
15+
├── src/
16+
│ └── component/ ( templated elements for the pages )
17+
│ └── content/ ( markdown files are all in here )
18+
│ └── utils/ ( utility function and constants that augment the site's data & paths & urls )
19+
│ └── constants.js ( Augments the site's image paths and urls )
20+
│ └── layout/ ( layout of the markdown data and layout of the page )
21+
│ └── pages/
22+
│ └── index.astro ( this is the home page wrapper )
23+
│ └── styles/ ( includes the global style of the entire site )
24+
└── package.json ( dependencies file )
25+
```
26+
27+
About Astro:
28+
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
29+
Any static assets, like images, can be placed in the `public/` directory.
30+
31+
## Project Commands
32+
All commands are run from the root of the project, from a terminal:
33+
34+
| Command | Action |
35+
| :--------------------- | :----------------------------------------------- |
36+
| `npm install` | Installs dependencies |
37+
| `npm run dev` | Starts local dev server at `localhost:3000` |
38+
| `npm run build` | Build your production site to `./dist/` |
39+
| `npm run preview` | Preview your build locally, before deploying |
40+
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
41+
| `npm run astro --help` | Get help using the Astro CLI |
42+
43+
## Need NPM, what is NPM?
44+
To run the above commands on your local environment, you will need to install NPM on your own environment.
45+
You can install it from here: https://nodejs.org/en/download.
46+
Please install based on the OS you are working on.
47+
To test if you have the it installed you should be able to type ```npm install``` or ```node -v```.
48+
49+
## License
50+
Astro: https://github.com/withastro/astro/blob/main/LICENSE
51+
52+
## To create a new article page
53+
1.) Go to the src > pages folder and create a new folder.
54+
Name the folder to the url name you want. ie. name: 4004-moore-lane -> url end will be /4004-moore-lane.
55+
2.) Create an `index.astro` file under the new folder.
56+
3.) Copy and paste the code from /alab ( under the same src/pages folder ) and use that as a starter.
57+
4.) Go to the src > content > articles folder and create a `.md` file.
58+
5.) Copy and paste the markdown layout from `DPEL-coming-soon.md`. Fill/Edit in the appropriate info as needed.
59+
6.) Go back to the `index.astro` file under the project folder you set up earlier from /pages. Update this line with your markdown (`.md`) file name --> `const assetContent = await Astro.glob("../../content/articles/fileName.md");`
60+
7.) Save your files and run `npm start dev` to run the project.
61+
8.) You can check this page by going to the name of the folder you set under the pages/ folder.
62+
63+
## To create a new license page
64+
1.) Go under the new folder you made for the article page and create new folder again with the url name you want.
65+
2.) Create an `index.astro` file under the new folder.
66+
3.) Copy and paste the code from /alab-license ( under the same src/pages folder ) and use that as a starter.
67+
4.) Go to the src > content > license folder and create a `.md` file.
68+
5.) Copy and paste the markdown layout from `alab-license.md`. Fill/Edit in the appropriate info as needed.
69+
6.) Go back to the `index.astro` file under the project's license folder you set up earlier from /pages. Update this line with your markdown (`.md`) file name --> `const licenseContent = await Astro.glob("../../../content/license/license-markdown-file-name.md");`
70+
7.) Save your files and run `npm start dev` to run the project.
71+
8.) You can check this page by going to the name of the folder you set under the pages/ folder.
72+
73+
## There are images on the page
74+
All images should be stored in the public/images/ folder. It is important that they are separated by project/page topic that they will be under for organization.
75+
76+
## Still need help?
77+
Please reach out to `assets-discussion@lists.aswf.io` or find us on the [ASWF Slack](https://slack.aswf.io/) at `#assets`

‎THIRD_PARTY.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Third-Party Project Licenses
2+
3+
This section documents the licenses of third-party projects that have been imported or incorporated into the DPEL site. All of these are compatible with the [main license](LICENSE) under which the DPEL site is open-sourced. Let us know if you notice any errors or omissions and we'd be happy to address them.
4+
5+
### [Astro](https://docs.astro.build/en/getting-started/)
6+
```
7+
MIT License
8+
9+
Copyright (c) 2021 Fred K. Schott
10+
11+
Permission is hereby granted, free of charge, to any person obtaining a copy
12+
of this software and associated documentation files (the "Software"), to deal
13+
in the Software without restriction, including without limitation the rights
14+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15+
copies of the Software, and to permit persons to whom the Software is
16+
furnished to do so, subject to the following conditions:
17+
18+
The above copyright notice and this permission notice shall be included in all
19+
copies or substantial portions of the Software.
20+
21+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27+
SOFTWARE.
28+
29+
30+
"""
31+
This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/sveltejs/kit repository:
32+
33+
Copyright (c) 2020 [these people](https://github.com/sveltejs/kit/graphs/contributors)
34+
35+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
36+
37+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
38+
39+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40+
"""
41+
42+
43+
"""
44+
This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/vitejs/vite repository:
45+
46+
MIT License
47+
48+
Copyright (c) 2019-present, Yuxi (Evan) You and Vite contributors
49+
50+
Permission is hereby granted, free of charge, to any person obtaining a copy
51+
of this software and associated documentation files (the "Software"), to deal
52+
in the Software without restriction, including without limitation the rights
53+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
54+
copies of the Software, and to permit persons to whom the Software is
55+
furnished to do so, subject to the following conditions:
56+
57+
The above copyright notice and this permission notice shall be included in all
58+
copies or substantial portions of the Software.
59+
60+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
61+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
62+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
63+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
64+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
65+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
66+
SOFTWARE.
67+
"""
68+
```
69+
70+
# Third-Party Software and Services
71+
72+
The DPEL site also uses the following software and services that are provided free of charge to open-source projects:
73+
74+
- [Astro to Github Pages](https://docs.astro.build/en/guides/deploy/github/#how-to-deploy) to deploy to Github Pages
75+
- [GitHub Actions](https://github.com/features/actions) for continuous integration

‎astro.config.mjs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import { defineConfig } from 'astro/config';
2+
3+
import tailwind from "@astrojs/tailwind";
4+
5+
// https://astro.build/config
6+
export default defineConfig({
7+
site: 'https://academysoftwarefoundation.github.io',
8+
base: '/dpel-website',
9+
// Will setup any new pages to be unpublished till draft is done
10+
markdown: {
11+
drafts: true,
12+
},
13+
integrations: [tailwind()]
14+
});

0 commit comments

Comments
 (0)