Skip to content

Commit d87774d

Browse files
author
doublebyte1
committed
- Updated README
1 parent e59b33b commit d87774d

2 files changed

Lines changed: 9 additions & 43 deletions

File tree

README-dist.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
## Introduction
44
This repository hosts the source of the OGC Developer Website https://developer.ogc.org
55

6-
Currently, the website is served from the [gh-pages](https://github.com/opengeospatial/developer-website/tree/gh-pages) branch.
6+
Currently, the website is served from the [gh-pages](https://github.com/opengeospatial/developer-website/tree/gh-pages) branch. Read [this note](#note-about-publishing-the-website), to understand how the website is generated.
77

8-
## Version 2.0
8+
## Version 3.0
99
This is now the main version.
1010

1111
Install:
@@ -16,25 +16,18 @@ Run locally (includes development server):
1616

1717
`npm start`
1818

19-
Generate static build:
19+
### Note about Publishing the Website
2020

21-
`npm run build`
21+
Commit all your changes to the `master` branch. **The `gh-pages` branch will be wiped each time, and generated dynamically from [GitHub actions](https://github.com/opengeospatial/developer-website/actions/)**. Apart from copying the static build, the action will copy the `api` folder and pull remote repos that live under `developer.ogc.org`. If you need to add anything else, just edit the [workflow file](https://github.com/opengeospatial/developer-website/blob/master/.github/workflows/main.yml) directly.
2222

23-
Publish to GitHub Pages with:
23+
## Contributing 🤝
2424

25-
`git subtree push --prefix dist origin gh-pages-v2`
25+
This website is a live project and we welcome contributions from the community! If you have suggestions for improvements, found a bug, or want to add new features, feel free to:
2626

27-
Forced update:
27+
* Open an [issue](https://github.com/opengeospatial/developer-website/issues) to start a discussion
28+
* Submit a [pull request](https://github.com/opengeospatial/developer-website/pulls) with your proposed changes
2829

29-
`git push origin `git subtree split --prefix dist master`:gh-pages-v2 --force`
30-
31-
If you just want to copy static files to the `api` folder, copy them to the `api` root folder and then run:
32-
33-
`npm run build`
34-
35-
`git subtree push --prefix dist origin gh-pages-v2`
36-
37-
(don't forget to commit/push the changes to the master branchs, as well)
30+
We appreciate your support in making this website better!
3831

3932
## Intellectual Property Rights
4033

0 commit comments

Comments
 (0)