diff --git a/docs/404.html b/docs/404.html index 30362f160..30496b4c8 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,13 +1,12 @@ - --- +# Copyright (c) 2021 Red Hat, Inc. and others +# +# This program and the accompanying materials are made available under the +# Apache Software License 2.0 which is available at: +# https://www.apache.org/licenses/LICENSE-2.0. +# +# SPDX-License-Identifier: Apache-2.0 + permalink: /404.html layout: default --- diff --git a/docs/Gemfile b/docs/Gemfile index e2cdb8a5b..b02d8630d 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -5,6 +5,7 @@ # https://www.apache.org/licenses/LICENSE-2.0. # # SPDX-License-Identifier: Apache-2.0 + source "https://rubygems.org" # Hello! This is where you manage which Jekyll version is used to run. # When you want to use a different version, change it below, save the diff --git a/docs/README.md b/docs/README.md index df7e3d4c8..daa22de06 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,7 +23,7 @@ These instructions will get you a copy of the eclipse-ee4j.github.io/cdi/ websit 3. Fork the [project repository](https://github.com/eclipse-ee4j/cdi), then clone your fork. - git clone https://github.com/eclipse-ee4j/cdi + git clone https://github.com/jakartaee/cdi 4. Change into the project directory: @@ -44,17 +44,18 @@ These instructions will get you a copy of the eclipse-ee4j.github.io/cdi/ websit **For more regarding the use of Jekyll, please refer to the [Jekyll Step by Step Tutorial](https://jekyllrb.com/docs/step-by-step/01-setup/).** ## Writing a Blog Post + To write a blog: -- create an author entry in [_authors](https://github.com/eclipse-ee4j/cdi/tree/master/docs/_authors) -- create an blog entry under [_posts](https://github.com/eclipse-ee4j/cdi/tree/master/docs/_posts) - -the file name is `yyyy-mm-dd-slug.adoc` -- `tags` should be used with some care as an archive page is created for of them. Below are some basic rules to try follow: +- create an author entry in [_authors](https://github.com/jakartaee/cdi/tree/master/docs/_authors) +- create a blog entry under [_posts](https://github.com/jakartaee/cdi/tree/master/docs/_posts) + - the file name is `yyyy-mm-dd-slug.adoc` +- `tag` or `tags` should be used with some care as an archive page is created for of them. Below are some basic rules to follow: - `cdi-release` used for CDI release blogs - `announcement` used for general announcement with some impact. - `development-tips` used for blogs with tips to develop with CDI. - tags are space separated list `tags:cdi-release announcement` - tags must be in lowercase -- it's in markdown format, there is an example as shown with [2021-10-25-way-to-cdi4.md](https://github.com/eclipse-ee4j/cdi/blob/master/docs/_posts/2021-10-25-way-to-cdi4.md) - - Be aware that the `date` attribute in the asciidoc preamble defines when the article will be published. Use a present date while writing your article to test locally, then switch to the actual target date before submitting. -- send a pull request against the master branch and when it is merged it will be automatically incorporated into the pages site. +- it's in Markdown format, see [2021-10-25-way-to-cdi4.md](https://github.com/jakartaee/cdi/blob/master/docs/_posts/2021-10-25-way-to-cdi4.md) for example +- the `date` attribute in the front matter defines when the article will be published. Use a present date while writing your article to test locally, then switch to the actual target date before submitting. +- send a pull request against the `main` branch and when it is merged it will be automatically incorporated into the site. diff --git a/docs/_authors/asd.md b/docs/_authors/asd.md index b058d6c0e..0de8dc9af 100644 --- a/docs/_authors/asd.md +++ b/docs/_authors/asd.md @@ -1,15 +1,14 @@ - --- +# Copyright (c) 2021 Red Hat, Inc. and others +# +# This program and the accompanying materials are made available under the +# Apache Software License 2.0 which is available at: +# https://www.apache.org/licenses/LICENSE-2.0. +# +# SPDX-License-Identifier: Apache-2.0 + short_name: asd name: Antoine Sabot-Durand position: Software Engineer --- -https://github.com/antoinesd \ No newline at end of file +[https://github.com/antoinesd](https://github.com/antoinesd) diff --git a/docs/_authors/ladt.md b/docs/_authors/ladt.md index c60567c7f..e8b230cbe 100644 --- a/docs/_authors/ladt.md +++ b/docs/_authors/ladt.md @@ -1,15 +1,14 @@ - --- +# Copyright (c) 2021 Red Hat, Inc. and others +# +# This program and the accompanying materials are made available under the +# Apache Software License 2.0 which is available at: +# https://www.apache.org/licenses/LICENSE-2.0. +# +# SPDX-License-Identifier: Apache-2.0 + short_name: ladt name: Ladislav Thon position: Software Engineer --- -https://github.com/Ladicek \ No newline at end of file +[https://github.com/Ladicek](https://github.com/Ladicek) diff --git a/docs/_authors/matn.md b/docs/_authors/matn.md index 6e2fe4424..f0c09d42a 100644 --- a/docs/_authors/matn.md +++ b/docs/_authors/matn.md @@ -1,15 +1,14 @@ - --- +# Copyright (c) 2021 Red Hat, Inc. and others +# +# This program and the accompanying materials are made available under the +# Apache Software License 2.0 which is available at: +# https://www.apache.org/licenses/LICENSE-2.0. +# +# SPDX-License-Identifier: Apache-2.0 + short_name: matn name: Matej Novotny position: Software Engineer --- -https://github.com/manovotn \ No newline at end of file +[https://github.com/manovotn](https://github.com/manovotn) diff --git a/docs/_authors/starksm.md b/docs/_authors/starksm.md index e5149f32b..19b737bcb 100644 --- a/docs/_authors/starksm.md +++ b/docs/_authors/starksm.md @@ -1,15 +1,14 @@ - --- +# Copyright (c) 2021 Red Hat, Inc. and others +# +# This program and the accompanying materials are made available under the +# Apache Software License 2.0 which is available at: +# https://www.apache.org/licenses/LICENSE-2.0. +# +# SPDX-License-Identifier: Apache-2.0 + short_name: starksm name: Scott M Stark position: Software Engineer --- -https://github.com/starksm64 \ No newline at end of file +[https://github.com/starksm64](https://github.com/starksm64) diff --git a/docs/_config.yml b/docs/_config.yml index 0af0941bd..dddac5c35 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -5,6 +5,7 @@ # https://www.apache.org/licenses/LICENSE-2.0. # # SPDX-License-Identifier: Apache-2.0 + # Welcome to Jekyll! # # This config file is meant for settings that affect your whole blog, values @@ -28,9 +29,9 @@ title: Jakarta CDI email: cdi-dev@eclipse.org description: >- # this means to ignore newlines until "baseurl:" - This is the pages site for the Jakarta Contents and Dependency Injection API and Specifications project. + This is the site for the Jakarta Contexts and Dependency Injection API and Specification project. baseurl: "/cdi" # the subpath of your site, e.g. /blog -url: "https://eclipse-ee4j.github.io" # the base hostname & protocol for your site, e.g. http://example.com +url: "https://jakartaee.github.io" # the base hostname & protocol for your site, e.g. http://example.com #twitter_username: #github_username: diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 0cd963b73..ff28e1afa 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -5,6 +5,7 @@ # https://www.apache.org/licenses/LICENSE-2.0. # # SPDX-License-Identifier: Apache-2.0 + - name: Home link: / - name: About diff --git a/docs/_layouts/author.html b/docs/_layouts/author.html index baee1b4d9..ca79f7df6 100644 --- a/docs/_layouts/author.html +++ b/docs/_layouts/author.html @@ -1,13 +1,12 @@ - --- +# Copyright (c) 2021 Red Hat, Inc. and others +# +# This program and the accompanying materials are made available under the +# Apache Software License 2.0 which is available at: +# https://www.apache.org/licenses/LICENSE-2.0. +# +# SPDX-License-Identifier: Apache-2.0 + layout: default ---