hazelcast-guides / guides-site Goto Github PK

Update guide titles so they reflect the objective of the guide, otherwise they're vague i.e. Hazelcast on Kubernetes could include how to operate it and many other concerns. Same goes about the subtitle - it should indicate what the goal is.

Hazelcast with Spring Boot -> Use Hazelcast in a Spring Boot Application
Subtitle: Create a basic Spring Boot application which can utilize Hazelcast

Hazelcast Client With Quarkus -> Connect To Hazelcast From A Quarkus Application
Subtitle: Create a basic Quarkus application which connects to a Hazelcast cluster.

Hazelcast On Kubernetes -> Deploy Hazelcast on Kubernetes
Subtitle: Learn how to deploy Hazelcast on a Kubernetes environment

etc

When a new guide repo is created and it's added as a new module in antora-playbook.yml, it's not published on the homepage unless it's pushed created & pushed manually for the first time.

Reproducer:

• Create a repo (R) from base guide, which has publisher action by default.
• Add secret token to the repo
• Include R in antora-playbook.yml and also in the homepage (home/modules/ROOT/pages/index.adoc)
• Update the content of R, under doc folder.

At this step, R is expected to be included in the website. However, even if the action exits with 0, it does not include the new content when it pushes.

• Create the new website manually and push to guides-site.
• Kick the publisher of R via updating its content. ---> WORKS

Looks like there is something missing when the website is created for the first time where a new module is added.

(cc: @hasancelik )

Having consistent guide headers on guide pages with the ones on the home would be better (see the changes in #10)
For instance, the title on home page differs from the one on guide page. The same goes for the See Also sections. This could be solved by setting titles in antora.yaml for each guide properly and using them in references.

As a guide reader I would like to know how to report typos/feedback/any_other_issue
Given the guides are maintained on github it's trivial to send a PR with a fix. What's not trivial is to find the right repo.

I can imagine a ribbon in a corner, or something simple like the "Send Us a Fix" prompt in a reference manual

We have a slack widget on hazelcast.org, a similar could be added to the guides site to encourage people to join our community.