1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# Jakarta CDI Website Based on Jekyll
## Getting Started
These instructions will get you a copy of the eclipse-ee4j.github.io/cdi/ website up and running on your local machine for development and testing purposes.
### Installation
[Jekyll static site generator docs](https://jekyllrb.com/docs/).
1. Install a full [Ruby development environment](https://jekyllrb.com/docs/installation/)
2. Install [bundler](https://jekyllrb.com/docs/ruby-101/#bundler) [gems](https://jekyllrb.com/docs/ruby-101/#gems)
gem install bundler
3. Fork the [project repository](https://github.com/eclipse-ee4j/cdi), then clone your fork.
git clone https://github.com/eclipse-ee4j/cdi
4. Change into the project directory:
cd cdi/docs
5. Use bundler to fetch all required gems in their respective versions
bundle install
6. Build the site and make it available on a local server
bundle exec jekyll serve
7. Now browse to http://localhost:4000
> If you encounter any unexpected errors during the above, please refer to the [troubleshooting](https://jekyllrb.com/docs/troubleshooting/#configuration-problems) page or the [requirements](https://jekyllrb.com/docs/installation/#requirements) page, as you might be missing development headers or other prerequisites.
**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:
- `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.
|
