search

jakartaee / jekyll-theme-jakarta-ee

This theme is currently experimental, but intended to provide the branding for Jakarta EE projects using GitHub pages for their documentation.
https://jakartaee.github.io/jekyll-theme-jakarta-ee/
Eclipse Public License 2.0
4 stars 14 forks source link

Create a documention site for using jekyll-theme-jakarta-ee #11

Closed chrisguindon closed 5 years ago

chrisguindon commented 5 years ago

With GitHub pages we can serve a website from the /docs folder in the master branch.

I was thinking we could create a small documentation website for this theme within this repo.

I think this would be useful for two reasons:

  1. We could write more details instructions for projects who wish to use the theme
  2. We could also use this test website to view and make sure that our changes doesn't break the website.

@jgallimore What do you think?

chrisguindon commented 5 years ago

Here's a quick start: https://chrisguindon.github.io/jekyll-theme-jakarta-ee/

I am simply using the content from the README.md for now.

jgallimore commented 5 years ago

Great idea, @chrisguindon!

chrisguindon commented 5 years ago

The documentation is live and it's available under jakarta.ee domain by default: https://jakarta.ee/jekyll-theme-jakarta-ee/

Should we take a look at moving this out of jakarta.ee domain?

jgallimore commented 5 years ago

Would that require this repository to shift to an outside of the jakartee organization (eclipse-ee4j, maybe)?

I don't have strong views, but it probably makes sense for it to be separate from the main website.

chrisguindon commented 5 years ago

I could't find documentation to disable the custom domain for this repo.

I've sent a support question to github for more information.

chrisguindon commented 5 years ago

I just heard back from Github and here's the answer:

Hi Christopher,

Thanks for writing in to GitHub Support and apologies for the delay. We're currently experiencing a high volume of requests, so we appreciate your patience.

When you attach a custom domain to a repository using the username.github.io naming scheme, this custom domain replaces all instances of username.github.io in the URLs for all other Pages sites served from the same account.

To stop this you'll need to rename your jakartaee/jakartaee.github.io to anything else. This will allow this site to continue serving under that custom domain,but the domain won't be inherited to other sites under that account.

Hope this helps! Let us know if you need anything else.

chrisguindon commented 5 years ago

jakartaee/jakartaee.github.io has been renamed to jakartaee/jakarta.ee

The documentation site is now available via: https://jakartaee.github.io/jekyll-theme-jakarta-ee/

Closing this issue!

jgallimore commented 5 years ago

Looks good, thanks @chrisguindon !