Olivier Goulet
asciidoc-wg.eclipse.org

Repository



asciidoc-wg.eclipse.org


The https://asciidoc-wg.eclipse.org website is generated with Hugo.


The AsciiDoc Working Group drives the standardization, adoption, and evolution of AsciiDoc. This group encourages and shapes the open, collaborative development of the AsciiDoc language and its processors.


Getting started


Prerequisites

The following pre-requisites are necessary to create a local preview of the site.
If you only want to change content without a local preview, only a text editor is necessary to change content.


Node and NPM (LTS 16.x) to install resources and dependencies - see https://nodejs.org/


Hugo to render site from templates and content - see https://gohugo.io/


Asciidoctor to transform AsciiDoc content to HTML - see https://asciidoctor.org/


Running a local preview of the site

Install dependencies, build assets and start a webserver:


yarn && hugo server --destination=public


You can find guidance on the page-level metadata here, and examples of the assorted page types (components) here.


Analyzing build problems

The CI/CD jobs for this project run on Eclipse WebDev’s Jenkins server.
Use this link to analyze logs of main builds as well as pull requests.


If there are problems with the build-server, have a look at https://www.eclipsestatus.io/ if there is a reported outage or scheduled maintenance.


The Netlify logs are not accessible to normal users.


Create an issue in repository https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues to get support.


Contributing


Login to Eclipse GitLab with your Eclipse user.
If you don’t have a user account yet, create a new account.


Fork the asciidoc-wg.eclipse.org repository.

Read more about forking projects in the GitLab documentation.


Clone repository: git clone https://gitlab.eclipse.org/[your username]/asciidoc-wg.eclipse.org.git


Create your feature branch: git checkout -b my-new-feature


Commit your changes: git commit -m 'Add some feature' -s


Push feature branch: git push origin my-new-feature


Submit a pull request


Declared Project Licenses

This program and the accompanying materials are made available under the terms
of the Eclipse Public License v. 2.0 which is available at
https://www.eclipse.org/legal/epl-2.0.


SPDX-License-Identifier: EPL-2.0


Related projects


EclipseFdn/solstice-assets


Images, less and JavaScript files for the Eclipse Foundation look and feel.


EclipseFdn/hugo-solstice-theme


Hugo theme of the Eclipse Foundation look and feel.


Bugs and feature requests


Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.


Author


Christopher Guindon (Eclipse Foundation)


https://twitter.com/chrisguindon


https://github.com/chrisguindon


Trademarks


Eclipse® is a Trademark of the Eclipse Foundation, Inc.


Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.


AsciiDoc® and the AsciiDoc Logo are Trademarks of the Eclipse Foundation, Inc.


Copyright and license


Copyright 2021-2022 the "Eclipse Foundation, Inc." and the asciidoc-wg.eclipse.org authors. Code released under the Eclipse Public License Version 2.0 (EPL-2.0).


The chat.svg icon is from the feather icons project and is MIT licensed