Skip to content

Royale project site built with Royale

Andrew Wetmore edited this page Apr 18, 2021 · 4 revisions

The current situation

We have an informative, attractive website. However, it requires WordPress running on a private machine, and uses a proprietary theme for its look.

The goal

Have an informative, attractive website built on and using the features of Apache Royale, and using open-source resources.

Requirements

  • Code resides in an Apache Git repository.
  • Retain all the significant features of the current website.
  • Responsive design that displays well on computers and mobile devices.
  • Does not require functions that exceed the "flat" requirements for an Apache TLP website.
  • Model good practices in code design and site architecture
  • Contents editable by any Royale PMC member, using the editor built in to Git.
  • Functions as a demonstration of using Royale in a real-world situation.
  • Compilable using the command line and in a way that integrates with Infra's continuous-integration system.

Other requirements?

Nice features to have

Demonstrates Royale strengths and capabilities, including

  • Use of theme and styles
  • Localization (at least the menus and top-level pages in each section. Which languages?)
  • ViewStates to control current display
  • Transitions / animations
  • Databinding
  • Component-based design
  • Our shiniest and most engaging controls; probably from the Jewel set
  • Documentation about the making of the site, as a teaching tool

Other nice features to have?

Not required

  • The new site does not have to duplicate the theme of the current site.
  • Localization does not have to extend (at least, not right away) to every page of documentation.

Other "not required"?

Resources

There are two unfinished projects to use Royale for building our project site:

  • Alex Harui worked on a proof of concept in 2018. The repository is https://github.com/apache/royale-asjs/tree/develop/examples/royale/RoyaleWebsite

  • Chris Dutz: "a lot of years ago I built into the Royale build the option to build a static Royale Website with Maven. I tried it out and you currently need to remove the <head> block in compiler-repo/src/site/site.xml and in compiler-repo/pom.xml comment out the archiver plugin in line 472-476...if you then run "mvn site" you get a website built in "target/site"...the default uses markdown, I configured it to use asciidoctor. Website content is in "src/site" directory. I stopped working on this a long time ago and therefore the configuration is a bit outdated."

Timeline?

It would be nice to have the new site available to display at ApacheCon 2021 in September, 2021, even if it is not yet "live".

Clone this wiki locally