Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-12: new homepage design #206

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
e34d31c
structure home
fantkolja Mar 27, 2024
2e2382e
style home WIP
fantkolja Mar 27, 2024
368d22f
style search-bar
fantkolja Apr 3, 2024
fec520c
wip
fantkolja Apr 3, 2024
00a8325
change fonts
fantkolja Apr 3, 2024
5c35cf1
style admonitions
fantkolja Apr 10, 2024
263e350
fix nav scroll
fantkolja Apr 12, 2024
6130d54
sidenav
fantkolja Apr 12, 2024
91842cd
sidenav
fantkolja Apr 13, 2024
7397dfd
update like feedback
fantkolja Apr 15, 2024
381c28e
unify docsearch
fantkolja Apr 17, 2024
c402002
unify docsearch
fantkolja Apr 17, 2024
b1c1c59
add more rows and columns
fantkolja Apr 18, 2024
d9b670a
add all correct titles
fantkolja Apr 18, 2024
cbdc168
add all correct titles
fantkolja Apr 18, 2024
7627f97
add links
fantkolja Apr 18, 2024
394fd4f
add links
fantkolja Apr 18, 2024
3a47156
add links
fantkolja Apr 18, 2024
0b40fb5
add links
fantkolja Apr 18, 2024
7b909a9
add links
fantkolja Apr 18, 2024
1a67381
fixes after review
fantkolja Apr 19, 2024
adfdcb7
fixes after review
fantkolja Apr 19, 2024
7303288
Fixing build failure.
Serdaro Apr 19, 2024
89e9bb8
fixes after review
fantkolja Apr 20, 2024
be2958c
fixes after review
fantkolja Apr 20, 2024
bf46ad8
fixes after review
fantkolja Apr 22, 2024
0e45e14
fixes after review
fantkolja Apr 22, 2024
8a8a4bc
fixes after review
fantkolja Apr 22, 2024
509c0d9
add cards calc
fantkolja Apr 25, 2024
136a290
add new home page
fantkolja Apr 26, 2024
8720726
add new home page
fantkolja Apr 26, 2024
af99e0c
add new home page
fantkolja Apr 26, 2024
880b61f
add new home page
fantkolja Apr 26, 2024
54affbd
add new home page
fantkolja Apr 26, 2024
ecd8dc8
add new home page
fantkolja Apr 26, 2024
db4c79e
add new home page
fantkolja Apr 26, 2024
a32c52e
add new home page
fantkolja Apr 26, 2024
5b957ef
merge master
fantkolja May 1, 2024
722df15
fixes after demo
fantkolja May 8, 2024
d89c515
fixes after demo
fantkolja May 8, 2024
82fef6f
add docs
fantkolja May 10, 2024
a5049e7
adjust right menu
fantkolja May 10, 2024
e0fdc0d
adjust header image
fantkolja May 10, 2024
8d985b6
adjust header image
fantkolja May 10, 2024
424ae3b
adjust header image
fantkolja May 10, 2024
75b6bc6
adjust header image
fantkolja May 10, 2024
3db1a37
add hz link
fantkolja May 13, 2024
ac306e5
styles
fantkolja May 13, 2024
bc096f8
add ai url
fantkolja May 13, 2024
43a2cfe
add kapa btn
fantkolja May 15, 2024
781c6c1
restyle kapa
fantkolja May 24, 2024
8fe9e48
restyle kapa
fantkolja May 24, 2024
2ee52e7
restyle kapa
fantkolja May 24, 2024
e041b03
restyle kapa
fantkolja May 24, 2024
a3cb2a6
restyle kapa
fantkolja May 24, 2024
543529a
versions picker
fantkolja Jun 13, 2024
be395f4
versions picker
fantkolja Jun 13, 2024
6490546
versions picker
fantkolja Jun 13, 2024
9c42a03
add hz query
fantkolja Jun 14, 2024
2db3459
add hz query
fantkolja Jun 14, 2024
6925ed2
add hz query
fantkolja Jun 14, 2024
8e9486f
add hz query
fantkolja Jun 14, 2024
ec5098b
DOC-11: add tracking tags to hazelcast.com links
oliverhowell Jun 17, 2024
12022c3
Merge branch 'feature/doc-12-new-homepage-design' of https://github.c…
oliverhowell Jun 17, 2024
0cb92b4
add external link indication
fantkolja Jun 18, 2024
33537dd
Merge branch 'feature/doc-12-new-homepage-design' of github.com:fantk…
fantkolja Jun 18, 2024
0311056
add external link indication
fantkolja Jun 18, 2024
c869609
add external link indication
fantkolja Jun 19, 2024
3c3ba1b
try fix tutorials
fantkolja Jun 25, 2024
652b353
try fix tutorials
fantkolja Jun 25, 2024
0d50c04
DOC-12: update homepage links and footer utm
oliverhowell Jul 1, 2024
98e8252
merge master
fantkolja Jul 1, 2024
27fc48c
merge master
fantkolja Jul 1, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .github/CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
:url-gulp: http://gulpjs.com
:url-node: https://nodejs.org
:url-node-dl: https://nodejs.org/en/download/
:feather-docs: https://feathericons.com/

The Hazelcast documentation UI is open source, and we welcome your contributions!

Expand Down Expand Up @@ -222,6 +223,24 @@ To test the search from the preview site, set the following environment variable
* `ALGOLIA_API_KEY` - your API key for Algolia
* `ALGOLIA_INDEX_NAME` - the name of the index

=== Icons

There is the {feather-docs}[feather] icons pack added to the UI. To use it, just add the following element

```
<i data-feather="briefcase" class="card-img"></i>
```

Please note, that the previous HTML snippet is replaced with the real icon after page load with the JS snippet:

```
<script>
feather.replace();
</script>
```

That snippet is already included in each page globally in `footer-scripts.hbs`, so you don't need to add it. But if you experience a delay in icon loading, then you probably should add it also in your page template or partial.

=== View Latest

If the version of the current page does not match the latest version of the component, a banner is displayed to notify the user.
Expand Down
2 changes: 1 addition & 1 deletion gulp.d/tasks/build-preview-pages.js
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ function compileLayouts (src) {

function copyImages (src, dest) {
return vfs
.src('**/*.{png,svg}', { base: src, cwd: src })
.src('**/*.{gif,ico,jpg,jpeg,png,svg,jpeg}', { base: src, cwd: src })
.pipe(vfs.dest(dest))
.pipe(map((file, enc, next) => next()))
}
Expand Down
2 changes: 1 addition & 1 deletion gulp.d/tasks/build.js
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ module.exports = (src, dest, preview) => () => {
.pipe(postcss((file) => ({ plugins: postcssPlugins, options: { file } }))),
vfs.src('font/*.{ttf,woff*(2)}', opts),
vfs
.src('img/**/*.{gif,ico,jpg,png,svg}', opts)
.src('img/**/*.{gif,ico,jpg,jpeg,png,svg,jpeg}', opts)
.pipe(
preview
? through()
Expand Down
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
"require-from-string": "~2.0",
"stylelint": "^10.1.0",
"stylelint-config-standard": "~20.0",
"typeface-roboto": "0.0.75",
"typeface-roboto-mono": "0.0.75",
"vinyl-buffer": "~1.0",
"vinyl-fs": "~3.0"
Expand Down
6 changes: 6 additions & 0 deletions preview-src/home/_images/right-arrow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions preview-src/how-to-hz.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= How to HZ
:page-layout: tutorial

Learn how to build and run applications with Hazelcast. Whether you want a simple getting started or an end-to-end example of a use case, use the search and filters below to find what you're looking for.
2 changes: 1 addition & 1 deletion preview-src/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<a href="https://docs.hazelcast.com/imdg/latest/getting-started.html">Get Started <img src="right-arrow.svg"></a>
</li>
</ul>

++++

++++
Expand Down
92 changes: 91 additions & 1 deletion preview-src/java.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,94 @@ NOTE: You do not need to set a license key for your Java clients for which you w
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.

Imagine a trading application where all the trading data are stored and
managed in a Hazelcast cluster with tens of members.

== Getting Started with Java Client

TIP: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.

Imagine a trading application where all the trading data are stored and
managed in a Hazelcast cluster with tens of members.

== Getting Started with Java Client

IMPORTANT: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.

Imagine a trading application where all the trading data are stored and
managed in a Hazelcast cluster with tens of members.

== Getting Started with Java Client

CAUTION: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.

Imagine a trading application where all the trading data are stored and
managed in a Hazelcast cluster with tens of members.

== Getting Started with Java Client or Maybe some other client

WARNING: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.


== Getting Started with Java Client

NOTE: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.

Imagine a trading application where all the trading data are stored and
managed in a Hazelcast cluster with tens of members.

== Getting Started with Java Client

TIP: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.

Imagine a trading application where all the trading data are stored and
managed in a Hazelcast cluster with tens of members.

== Getting Started with Java Client

IMPORTANT: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.

Imagine a trading application where all the trading data are stored and
managed in a Hazelcast cluster with tens of members.

== Getting Started with Java Client

CAUTION: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.

Imagine a trading application where all the trading data are stored and
managed in a Hazelcast cluster with tens of members.

== Getting Started with Java Client

WARNING: You do not need to set a license key for your Java clients for which you want to
use Hazelcast IMDG Enterprise features. Hazelcast IMDG Enterprise license keys are
required only for members.


== Getting Started with Java Client

Simply include the `hazelcast.jar` dependency in your classpath to start using
the Hazelcast Java client. Once included, you can start using this client as if
you are using the Hazelcast API. The differences are discussed in the below sections.

== Getting Started with Java Client

If you prefer to use Maven, simply add the `hazelcast` dependency
to your `pom.xml`, which you may already have done to start using
Hazelcast IMDG:
Expand Down Expand Up @@ -55,6 +139,8 @@ clientConfig.getNetworkConfig().addAddress("10.90.0.1", "10.90.0.2:5702");

See the <<configuring-java-client, Configuring Java Client section>> for more information.

== Getting Started with Java Client

The second step is initializing the `HazelcastInstance` to be connected to the cluster.

```
Expand All @@ -65,6 +151,8 @@ HazelcastInstance client = HazelcastClient.newHazelcastClient(clientConfig);

Let's create a map and populate it with some data.

== Getting Started with Java Client

[source,java]
----
IMap<String, Customer> mapCustomers = client.getMap("customers"); //creates the map proxy
Expand All @@ -74,8 +162,10 @@ mapCustomers.put("2", new Customer("Ali", "Selam"));
mapCustomers.put("3", new Customer("Avi", "Noyan"));
----

== Getting Started with Java Client

As the final step, if and when you are done with your client, you can shut it down as shown below:

```
client.shutdown();
```
```
4 changes: 4 additions & 0 deletions preview-src/tutorials.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
= TUTORIALS & RECIPES
:page-layout: tutorials-landing

Learn how to build and run applications with Hazelcast. Whether you want a simple getting started or an end-to-end example of a use case, use the search and filters below to find what you're looking for.
77 changes: 67 additions & 10 deletions preview-src/ui-model.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ site:
title: Documentation Preview
homeUrl: &home_url /index.html
# uncomment below to test analytics locally
# keys:
keys:
# googleAnalytics: 'GTM-MQ59XD6'
aiSearchId: 'ad664bf0-07e2-42e7-9150-2e1b04b15cca'
components:
- name: abc
title: Hazelcast IMDG
Expand All @@ -19,6 +20,42 @@ site:
version: '4.0'
displayVersion: '4.0'
latestVersion: *latest_version_abc
- name: tutorial
title: How to HZ
url: '/how-to-hz.html'
versions:
- &latest_version_hz
url: '/how-to-hz.html'
version: '4.1'
displayVersion: '4.1'
- url: '/how-to-hz.html'
version: '4.0'
displayVersion: '4.0'
latestVersion: *latest_version_hz
- name: tutorials
title: Tutorials
url: '/tutorials.html'
versions:
- &latest_version_tutorials
url: '/tutorials.html'
version: '4.1'
displayVersion: '4.1'
- url: '/tutorials.html'
version: '4.0'
displayVersion: '4.0'
latestVersion: *latest_version_tutorials
- name: def
title: Management Center
url: '/java.html'
versions:
- &latest_version_def
url: '/java.html'
version: '4.1'
displayVersion: '4.1'
- url: '/java.html'
version: '4.0'
displayVersion: '4.0'
latestVersion: *latest_version_def
- &component
name: home
title: &component_title Home
Expand All @@ -32,7 +69,8 @@ page:
url: *home_url
home: true
title: Java Client
component: abc
component:
title: Dev Preview
componentVersion: *latest_version_abc
version: '4.1'
displayVersion: '4.1'
Expand Down Expand Up @@ -65,17 +103,36 @@ page:
url: '#'
navigation:
- root: true
- content: Quickstart
url: '#1'
urlType: internal
items:
- content: Quickstart
url: '#'
urlType: fragment
- content: Hazelcast Clients
url: '#'
urlType: fragment
items:
- content: Java Client
url: '/java.html'
urlType: internal
- content: C++ Client
url: '#'
url: '#3'
urlType: internal
- content: How to HZ
url: '/how-to-hz.html#4'
urlType: internal
- content: Hazelcast Clients
url: '#2'
urlType: internal
items:
- content: Java Client
url: '/java.html'
urlType: internal
- content: C++ Client
url: '#3'
urlType: internal
- content: Hazelcast Deep Client. Pretty long
url: '#4'
urlType: fragment
items:
- content: Java Client 2
url: '/java2.html'
urlType: internal
- content: C++ Client
url: '#5'
urlType: internal
Loading
Loading