-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
π Read.me β Adding content to improve F5 clarity, and project structuβ¦
β¦re details (#2248) * seeing if this fixes issues * removing comments and moving things around as per feedback * removing comments * moving things to contribution file from the readme * linking to additional documentation * Update _docs/Definition-of-Done.md Co-authored-by: Gert Marx [SSW] <gert.marx@marxoz.com> * Update _docs/Definition-of-Done.md Co-authored-by: Gert Marx [SSW] <gert.marx@marxoz.com> * Update _docs/Definition-of-Done.md Co-authored-by: Gert Marx [SSW] <gert.marx@marxoz.com> * mentioning node version numbers --------- Co-authored-by: Gert Marx [SSW] <gert.marx@marxoz.com>
- Loading branch information
1 parent
c240a40
commit 74d239f
Showing
6 changed files
with
155 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,68 @@ | ||
# Tina.io website | ||
### Hi Legends π | ||
# <p align="center">Tina.io β the Website for [TinaCMS](https://github.com/tinacms/tinacms)</p> | ||
|
||
Source code for the tina.io website, including the TinaCMS documentation and blog. | ||
|
||
Source code for the [tina.io](https://tina.io) website. | ||
Found a bug? Create a PBI and we'll look into it. | ||
|
||
## Development | ||
|
||
``` | ||
## π§Ώ Vision | ||
|
||
Make a wesbite to communicate the awesomeness of TinaCMS. | ||
|
||
## π οΈ Tech Stack | ||
|
||
Static web application built with... | ||
|
||
- [React](https://reactjs.org/) | ||
- [Next.js](https://nextjs.org/) | ||
- [TypeScript](https://www.typescriptlang.org/) | ||
- [Tailwind CSS](https://tailwindcss.com/) | ||
|
||
for Node versions, check [this](https://tina.io/docs/setup-overview/) docs page. | ||
|
||
- and of course... [TinaCMS](https://github.com/tinacms/tinacms)! π¦ | ||
|
||
Hosting and deployment... | ||
|
||
- GitHub and [Vercel](https://vercel.com/) | ||
|
||
<br> | ||
|
||
## π οΈ Dependency Installation + Setup | ||
|
||
We're using [pnpm](https://pnpm.io/) as the package manager for node. | ||
|
||
```bash | ||
cp .env.example .env | ||
pnpm i | ||
``` | ||
|
||
**Note**: Python is required for gyp β install [python](https://www.python.org/downloads/) and if necessary (newer python versions) the [setup tools](https://stackoverflow.com/a/77638742). | ||
|
||
<br> | ||
|
||
## π§π»βπ» Running the Project | ||
```bash | ||
pnpm dev | ||
``` | ||
This will spin up the react/Next project locally, running on [localhost:3000](http://localhost:3000) (react app) and [localhost:4001](http://localhost:4001/graphql) (playground for testing graphql against the Tina datalayer). | ||
|
||
## Vision | ||
Make a wesbite to communicate the awesomeness of TinaCMS | ||
<br> | ||
|
||
## Tech Stack | ||
- NextJS | ||
- TinaCMS | ||
- GitHub | ||
- Markdown | ||
## Not Familiar with Tina? | ||
|
||
We've put together a simple explanation of the project directory β in [_docs/Directory-Structure](_docs/Directory-Structure.md). | ||
|
||
### Testing Local TinaCMS Changes | ||
This should give you an idea of how it all fits into the project. | ||
|
||
If you have the **tinacms** repository cloned locally you can use it when running **tina.io**: | ||
Additionally, the Tina [docs](https://tina.io/docs/) contains the usage details for development with Tina. | ||
|
||
``` | ||
TINA=../path/to/tinacms pnpm dev | ||
``` | ||
<br> | ||
|
||
You can also specify which packages you want to watch: | ||
## Additional Documentation | ||
|
||
``` | ||
TINA=../path/to/tinacms TINA_WATCH=@tinacms/forms,react-tinacms-inline | ||
``` | ||
- [Definition of Done (work requirements)](/_docs/Definition-of-Done.md) | ||
- [Definition of Ready (PBI requrements)](/_docs/Definition-of-Ready.md) | ||
- [Contribution Guidelines](CONTRIBUTING.md) | ||
|
||
> ### Warning | ||
> | ||
> This will only work for packages loaded by webpack. That means that environments which don't use | ||
> webpack (i.e. SSR builds) will not use this alias. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Definition Of Done | ||
|
||
An issue in this repository can be closed (considered done) for... | ||
|
||
### Code + Content Changes | ||
|
||
1. Code compiles and the change aligns with the issue description. All tasks related to the issue have been completed. | ||
1. When the latest commit has been manually tested against a preview deployment. | ||
1. The code has been reviewed and approved by a project maintainer. | ||
|
||
1. Code has been deployed to production. | ||
1. Any bugs or technical debt that arise from the issue have been logged in a PBI that links to this code change. | ||
1. Issue had been closed with a closing comment added describing solution or linking changed pages. | ||
1. All relevant automated tests have been executed and passed. | ||
|
||
|
||
### Other Tasks | ||
|
||
1. All issue tasks have been ticked. | ||
|
||
1. PO has signed off on the task. | ||
1. Issue had been closed with a closing comment added describing solution or last status. | ||
1. Done email has been sent (if required). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Definition Of Ready | ||
|
||
Prior to being actioned, an issue in this repository should at minimum contain... | ||
|
||
- Enough detail for the team (or future teams) to action | ||
- Effort assigned (we use the [SSW recomendation](https://www.ssw.com.au/rules/estimating-do-you-know-how-to-size-user-stories-effectively/) for business and effort value estimates). | ||
|
||
...possible efforts are 0, 1, 2, 4, 8, 16 with each point of effort corresponding to a quarter day (~2 hours). Larger tasks should be done over multiple PBIs. | ||
- We're not using business values for this project. | ||
- Assigned to `backlog ready` with PO approval. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# ποΈ Directory Structure | ||
|
||
Last updated: 26/09/2024 | ||
|
||
``` | ||
. | ||
βββ components/ | ||
β βββ DocumentNavigation/ | ||
β β βββ ... various navigation menu components for the docs | ||
β βββ layout/ | ||
β β βββ ... wrappers for site pages | ||
β βββ blocks/ | ||
β β βββ ... Tina block-editing components and schemas | ||
β β βββ ... π¦ https://tina.io/docs/editing/blocks/ π¦ | ||
β βββ tinaMarkdownComponents/ | ||
β β βββ ... Rich-Text styling and embedded components | ||
β β βββ ... π¦ https://tina.io/docs/editing/markdown/ π¦ | ||
β βββ toc/ | ||
β β βββ ... contains docs table of contents (toc) schema | ||
β β βββ ... generated toc component from doc headings | ||
β βββ ui/ | ||
β β βββ ... re-usable utility components | ||
β βββ styles/ | ||
β β βββ ... mix of styling code, TODO: standardise this | ||
β βββ β | ||
βββ content/ | ||
β βββ ... π¦ π¦ π¦ (tina-managed site content) | ||
βββ data-api/ and indices/ | ||
β βββ ... related to algolia and content searching | ||
βββ pages/ | ||
β βββ ... π₯οΈ nextjs page router π₯οΈ | ||
βββ public/ | ||
β βββ ... assets | ||
βββ rss/ | ||
β βββ ... rss generation (SEO or other reasons) | ||
βββ scripts/ | ||
β βββ content-auditor/ | ||
β β βββ ... local AI audit script for /content | ||
β β βββ ... π¦ https://ollama.com/ - unafilliated llama related software π¦ | ||
β βββ β | ||
βββ styles/ (tailwind config) | ||
βββ tina/ | ||
β βββ collectionsSchema/ | ||
β β βββ ... Tina schema definitions (other than block templates) | ||
β β βββ ... π¦ https://tina.io/docs/reference/schema/ π¦ | ||
β βββ β | ||
βββ utils/ | ||
β βββ ... function definitions | ||
βββ ... project config | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters