Skip to content
Snippets Groups Projects
Commit 046e6b29 authored by Sébastien Heurtematte's avatar Sébastien Heurtematte :speech_balloon:
Browse files
parent 434a113b
No related branches found
No related tags found
No related merge requests found
...@@ -15,7 +15,7 @@ hugo-eclipsefdn-website-boilerplate ...@@ -15,7 +15,7 @@ hugo-eclipsefdn-website-boilerplate
The project maintains the following source code repositories The project maintains the following source code repositories
* https://github.com/EclipseFdn/hugo-eclipsefdn-website-boilerplate * https://gitlab.eclipse.org/eclipsefdn/it/releng/chat-service/chat-service-website
## Eclipse Contributor Agreement ## Eclipse Contributor Agreement
...@@ -36,4 +36,4 @@ https://www.eclipse.org/projects/handbook/#resources-commit ...@@ -36,4 +36,4 @@ https://www.eclipse.org/projects/handbook/#resources-commit
## Contact ## Contact
Contact the Eclipse Foundation Webdev team via webdev@eclipse-foundation.org. Contact the Eclipse Foundation releng team via releng@eclipse-foundation.org.
# Notices for hugo-eclipsefdn-website-boilerplate # Notices for chat-service-website
This content is produced and maintained by the Eclipse Foundation. This content is produced and maintained by the Eclipse Foundation.
* Project home: https://github.com/EclipseFdn/hugo-eclipsefdn-website-boilerplate * Project home: https://gitlab.eclipse.org/eclipsefdn/it/releng/chat-service/chat-service-website
## Trademarks ## Trademarks
......
# hugo-eclipsefdn-website-boilerplate # Chat-service-website
This boilerplate was created to help Eclipse Projects migrate their website to Hugo! Chat service documentation is based on [Hugo boilerplate](https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-eclipsefdn-website-boilerplate) provided by Eclipse Foundation.
## Getting started ## Getting started
Clone the project with submodules and start a web server: Clone the project with submodules and start a web server:
```bash ```bash
git clone --recurse-submodules https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-eclipsefdn-website-boilerplate.git git clone --recurse-submodules https://gitlab.eclipse.org/eclipsefdn/it/releng/chat-service/chat-service-website
cd hugo-eclipsefdn-website-boilerplate cd chat-service-website
hugo server hugo server
``` ```
...@@ -30,7 +30,7 @@ You should first put your Hugo sources in a dedicated Git repository, either at ...@@ -30,7 +30,7 @@ You should first put your Hugo sources in a dedicated Git repository, either at
Note that each and every Eclipse project automatically gets a Git repository with `git.eclipse.org/www.eclipse.org/<project_name>` (see this [repository index](https://git.eclipse.org/r/plugins/gitiles/www.eclipse.org/) for complete list). This is not where you want to push your Hugo sources. This repository contains the webpages that are automatically and regularly pulled and published on the www.eclipse.org HTTP server. All the content from the master branch will eventually be available at the URL https://www.eclipse.org/<project_name>. Note that each and every Eclipse project automatically gets a Git repository with `git.eclipse.org/www.eclipse.org/<project_name>` (see this [repository index](https://git.eclipse.org/r/plugins/gitiles/www.eclipse.org/) for complete list). This is not where you want to push your Hugo sources. This repository contains the webpages that are automatically and regularly pulled and published on the www.eclipse.org HTTP server. All the content from the master branch will eventually be available at the URL https://www.eclipse.org/<project_name>.
We recommend that our projects start with forking our [hugo-eclipsefdn-website-boilerplate](https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-eclipsefdn-website-boilerplate) project. We recommend that our projects start with forking our [chat-service-website](https://gitlab.eclipse.org/eclipsefdn/it/releng/chat-service/chat-service-website) project.
Once your Hugo sources are in the proper repository, update the file named `Jenkinsfile` at the root of the repository with the proper value for `PROJECT_NAME` and `PROJECT_BOT_NAME` environment variable. We also expect projects to update the README.md, config.toml and all the files in the content folder. Once your Hugo sources are in the proper repository, update the file named `Jenkinsfile` at the root of the repository with the proper value for `PROJECT_NAME` and `PROJECT_BOT_NAME` environment variable. We also expect projects to update the README.md, config.toml and all the files in the content folder.
...@@ -40,8 +40,8 @@ The `Jenkinsfile` example assumes that your project will use `main` as the defau ...@@ -40,8 +40,8 @@ The `Jenkinsfile` example assumes that your project will use `main` as the defau
## Contributing ## Contributing
1. [Fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) the [hugo-eclipsefdn-website-boilerplate](https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-eclipsefdn-website-boilerplate) repository 1. [Fork](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) the [chat-service-website](https://gitlab.eclipse.org/eclipsefdn/it/releng/chat-service/chat-service-website) repository
2. Clone repository: `git clone --recurse-submodules https://gitlab.eclipse.org/[your_gitlab_username]/hugo-eclipsefdn-website-boilerplate.git` 2. Clone repository: `git clone --recurse-submodules https://gitlab.eclipse.org/[your_gitlab_username]/chat-service-website.git`
3. Create your feature branch: `git checkout -b my-new-feature` 3. Create your feature branch: `git checkout -b my-new-feature`
4. Commit your changes: `git commit -m 'Add some feature' -s` 4. Commit your changes: `git commit -m 'Add some feature' -s`
5. Push feature branch: `git push origin my-new-feature` 5. Push feature branch: `git push origin my-new-feature`
...@@ -71,10 +71,11 @@ Have a bug or a feature request? Please search for existing and closed issues. I ...@@ -71,10 +71,11 @@ Have a bug or a feature request? Please search for existing and closed issues. I
## Author ## Author
**Christopher Guindon (Eclipse Foundation)** **Sébastien Heurtematte (Eclipse Foundation)**
- <https://twitter.com/chrisguindon> - <https://twitter.com/heurtematte>
- <https://github.com/chrisguindon> - <https://github.com/heurtematte>
- <https://gitlab.com/sebastien.heurtematte1>
## Trademarks ## Trademarks
...@@ -83,4 +84,4 @@ Have a bug or a feature request? Please search for existing and closed issues. I ...@@ -83,4 +84,4 @@ Have a bug or a feature request? Please search for existing and closed issues. I
## Copyright and license ## Copyright and license
Copyright 2021 the [Eclipse Foundation, Inc.](https://www.eclipse.org) and the [hugo-eclipsefdn-website-boilerplate authors](https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-eclipsefdn-website-boilerplate/-/graphs/main). Code released under the [Eclipse Public License Version 2.0 (EPL-2.0)](https://gitlab.eclipse.org/eclipsefdn/it/webdev/hugo-eclipsefdn-website-boilerplate/-/blob/main/LICENSE). Copyright 2023 the [Eclipse Foundation, Inc.](https://www.eclipse.org) and the [chat-service-website authors](https://gitlab.eclipse.org/eclipsefdn/it/releng/chat-service/chat-service-website). Code released under the [Eclipse Public License Version 2.0 (EPL-2.0)](https://gitlab.eclipse.org/eclipsefdn/it/releng/chat-service/chat-service-website/-/blob/main/LICENSE).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment