From d3ca4f0a5753c8a79a17230ba0c863b0fdd2b98d Mon Sep 17 00:00:00 2001 From: Ladislav Thon Date: Mon, 26 Feb 2024 15:18:22 +0100 Subject: [PATCH] fix license headers and some other small things in the website --- docs/404.html | 17 ++++++------ docs/Gemfile | 1 + docs/README.md | 17 ++++++------ docs/_authors/asd.md | 19 +++++++------ docs/_authors/ladt.md | 19 +++++++------ docs/_authors/matn.md | 19 +++++++------ docs/_authors/starksm.md | 19 +++++++------ docs/_config.yml | 5 ++-- docs/_data/navigation.yml | 1 + docs/_layouts/author.html | 17 ++++++------ docs/_layouts/post.html | 17 ++++++------ docs/_posts/2021-10-25-pages-here.md | 26 +++++++++--------- docs/_posts/2021-10-25-way-to-cdi4.md | 22 +++++++-------- ...03-you-know-build-compatible-extensions.md | 22 +++++++-------- docs/_posts/2022-01-24-400-RC3-spec.md | 24 ++++++++--------- docs/about.md | 27 ++++++++----------- docs/authors.html | 17 ++++++------ docs/index.md | 19 ++++++------- 18 files changed, 142 insertions(+), 166 deletions(-) diff --git a/docs/404.html b/docs/404.html index 30362f16..30496b4c 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 e2cdb8a5..b02d8630 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 df7e3d4c..daa22de0 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 b058d6c0..0de8dc9a 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 c60567c7..e8b230cb 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 6e2fe442..f0c09d42 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 e5149f32..19b737bc 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 0af0941b..dddac5c3 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 0cd963b7..ff28e1af 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 baee1b4d..ca79f7df 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 ---

{{ page.name }}

diff --git a/docs/_layouts/post.html b/docs/_layouts/post.html index 57938560..45dc8251 100644 --- a/docs/_layouts/post.html +++ b/docs/_layouts/post.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 ---

{{ page.title }}

diff --git a/docs/_posts/2021-10-25-pages-here.md b/docs/_posts/2021-10-25-pages-here.md index f5a78da9..6b601ee7 100644 --- a/docs/_posts/2021-10-25-pages-here.md +++ b/docs/_posts/2021-10-25-pages-here.md @@ -1,20 +1,18 @@ - --- -layout: post -title: "Jakarta CDI GitHub Pages" -date: 2021-10-25 22:08:50 -0500 -categories: announcement +# 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 + +title: "Jakarta CDI GitHub Pages" +date: 2021-10-25 22:08:50 -0500 author: starksm +tag: announcement --- # CDI GitHub Pages -The GitHub pages for Jakarta CDI has arrived. See the [README.md](https://github.com/eclipse-ee4j/cdi/tree/master/docs/README.md) file for how to build the pages site locally, and how to create a blog entry. \ No newline at end of file +The GitHub pages for Jakarta CDI has arrived. See the [README.md](https://github.com/jakartaee/cdi/tree/master/docs/README.md) file for how to build the pages site locally, and how to create a blog entry. diff --git a/docs/_posts/2021-10-25-way-to-cdi4.md b/docs/_posts/2021-10-25-way-to-cdi4.md index 19e8e8a8..b5c13f8f 100644 --- a/docs/_posts/2021-10-25-way-to-cdi4.md +++ b/docs/_posts/2021-10-25-way-to-cdi4.md @@ -1,20 +1,16 @@ - --- +# 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 + title: "On the Way to CDI 4.0" summary: Overview of changes coming to CDI 4.0 -layout: post author: matn -tag: Release -priority: 1 -change_frequency: daily +tag: release --- As you probably know, work is well under way for projects aiming to land in Jakarta EE 10 space and CDI is no exception. In fact, the specification is close to being rounded up for its next major release hence it is the right time to summarize what is coming. diff --git a/docs/_posts/2021-12-03-you-know-build-compatible-extensions.md b/docs/_posts/2021-12-03-you-know-build-compatible-extensions.md index 32d60017..049a68cd 100644 --- a/docs/_posts/2021-12-03-you-know-build-compatible-extensions.md +++ b/docs/_posts/2021-12-03-you-know-build-compatible-extensions.md @@ -1,23 +1,19 @@ - --- +# 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 + title: "You already know Build Compatible Extensions" summary: Comparison of Portable Extensions and Build Compatible Extensions -layout: post author: ladt tag: development-tips -priority: 1 -change_frequency: daily --- -As you have learned from a [previous post](https://eclipse-ee4j.github.io/cdi/2021/10/25/way-to-cdi4.html), CDI Lite comes with a new extension API called _Build Compatible Extensions_. +As you have learned from a [previous post](https://jakartaee.github.io/cdi/2021/10/25/way-to-cdi4.html), CDI Lite comes with a new extension API called _Build Compatible Extensions_. In this post, you will learn more about this API by comparison with _Portable Extensions_ and my hope is that by the end, you will see that _you already know Build Compatible Extensions_. If you don't know Portable Extensions, don't worry. diff --git a/docs/_posts/2022-01-24-400-RC3-spec.md b/docs/_posts/2022-01-24-400-RC3-spec.md index 40fc16e4..26e2fc4b 100644 --- a/docs/_posts/2022-01-24-400-RC3-spec.md +++ b/docs/_posts/2022-01-24-400-RC3-spec.md @@ -1,18 +1,16 @@ - --- -layout: post -title: "Jakarta CDI 4.0 Draft Specification" -date: 2022-01-24 20:00:00 -0500 -categories: announcement +# 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 + +title: "Jakarta CDI 4.0 Draft Specification" +date: 2022-01-24 20:00:00 -0500 author: starksm +tag: announcement --- A draft of the 4.0 CDI specification is available in the current build of the 4.0.0-RC3 API [jakarta-cdi-spec-4.0.pdf](https://ci.eclipse.org/cdi/job/CDI%20Release-JDK11/25/artifact/spec/target/generated-docs/jakarta-cdi-spec-4.0.pdf). diff --git a/docs/about.md b/docs/about.md index 40da9590..88ca331b 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,24 +1,19 @@ - --- +# 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: page title: About permalink: /about/ --- -This is the main Jakarta Contexts and Dependency Injection (CDI) pages site. It contains information about the latest news on Jakarta CDI. - -You can find the source code for this site in the docs directory of: -[docs](https://github.com/eclipse-ee4j/cdi/) - -You can find the source code for the Jakarta CDI API and Specification at: -[cdi](https://github.com/eclipse-ee4j/cdi/) +This is the main Jakarta Contexts and Dependency Injection (CDI) site. It contains information about the latest news on Jakarta CDI. +You can find the source code for this site in the `docs` directory: [docs](https://github.com/jakartaee/cdi/tree/main/docs) +You can find the source code for the Jakarta CDI API and Specification at: [cdi](https://github.com/jakartaee/cdi/) diff --git a/docs/authors.html b/docs/authors.html index c7531c40..68a3be69 100644 --- a/docs/authors.html +++ b/docs/authors.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 title: Authors --- diff --git a/docs/index.md b/docs/index.md index 9b95a9b3..096acbea 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +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 + # Feel free to add content and custom Front Matter to this file. # To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults layout: home --- - -