README.md - incubator-annotator-website - Git at Google

 # Apache Annotator (incubating) Website

 The site is currently in static HTML hosted out of the `content/` directory.

 Any pre-generated/rendered content or documentation should be added to additional
 folders in the root of this repo.

 ## Publishing

 The `asf-site` branch gets published to an Apache HTTPD static hosting environment
 run by the Apache infrastructure team.

 To update the demo, update the submodule (`git submodule update --remote`), rebuild (`yarn build`; in this repo, not inside the submodule), and commit the changes it made in `content/`.

 To add documentation add Markdown to the `docs/` folder. Further templating
 and build configuration of the `docs/` content can be done in the `.eleventy.js`
 file (since it's built with [11ty.dev](https://11ty.dev/)).

 ## Developing

 ##### Requirements

 - [node](https://nodejs.org) >= 10.x
 - [yarn](https://www.yarnpkg.com/) >= 1.5.1

 This website repository contains the main project repository as a git submodule, in order to build its demo without duplicating the code.

 Run `git submodule init && git submodule update --remote` to pull in the submodule.

 Run `yarn install` to install development dependencies.

 Run `yarn build` to build the demo code and docs content (it will overwrite
 `content/demo` and `content/docs`).

 Run `yarn serve` to build the demo and docs as well as serve and watch (with
 live reload on changes to the `src/` directory *only*).

 Note: if you receive a `ERR_OSSL_EVP_UNSUPPORTED` error, you can resolve this
 by using the legacy SSL provider: `export NODE_OPTIONS=--openssl-legacy-provider`

 ## Organizing

 We also use the [Milestones](https://github.com/apache/incubator-annotator-website/milestones?direction=asc&sort=due_date&state=open) for [this repo on GitHub](https://github.com/apache/incubator-annotator-website/) to track our quarterly board reports.

 Web site [issues](https://github.com/apache/incubator-annotator-website/issues/) and [PRs](https://github.com/apache/incubator-annotator-website/pulls) are still more than welcome, though!

 # License

 Apache License 2.0 (obviously...:wink:)
	# Apache Annotator (incubating) Website

	The site is currently in static HTML hosted out of the `content/` directory.

	Any pre-generated/rendered content or documentation should be added to additional
	folders in the root of this repo.

	## Publishing

	The `asf-site` branch gets published to an Apache HTTPD static hosting environment
	run by the Apache infrastructure team.

	To update the demo, update the submodule (`git submodule update --remote`), rebuild (`yarn build`; in this repo, not inside the submodule), and commit the changes it made in `content/`.

	To add documentation add Markdown to the `docs/` folder. Further templating
	and build configuration of the `docs/` content can be done in the `.eleventy.js`
	file (since it's built with [11ty.dev](https://11ty.dev/)).

	## Developing

	##### Requirements

	- [node](https://nodejs.org) >= 10.x
	- [yarn](https://www.yarnpkg.com/) >= 1.5.1

	This website repository contains the main project repository as a git submodule, in order to build its demo without duplicating the code.

	Run `git submodule init && git submodule update --remote` to pull in the submodule.

	Run `yarn install` to install development dependencies.

	Run `yarn build` to build the demo code and docs content (it will overwrite
	`content/demo` and `content/docs`).

	Run `yarn serve` to build the demo and docs as well as serve and watch (with
	live reload on changes to the `src/` directory only).

	Note: if you receive a `ERR_OSSL_EVP_UNSUPPORTED` error, you can resolve this
	by using the legacy SSL provider: `export NODE_OPTIONS=--openssl-legacy-provider`

	## Organizing

	We also use the [Milestones](https://github.com/apache/incubator-annotator-website/milestones?direction=asc&sort=due_date&state=open) for [this repo on GitHub](https://github.com/apache/incubator-annotator-website/) to track our quarterly board reports.

	Web site [issues](https://github.com/apache/incubator-annotator-website/issues/) and [PRs](https://github.com/apache/incubator-annotator-website/pulls) are still more than welcome, though!

	# License

	Apache License 2.0 (obviously...:wink:)