eclipse / ceylon-lang.org Goto Github PK

Awestruct built static website for ceylon-lang.org

HTML 53.70% Ruby 15.92% JavaScript 17.90% CSS 12.48%

ceylon-lang.org's Introduction

layout	title	tab	author
code	Building the website	code	Emmanuel Bernard

How to build ceylon-lang.org

A bit of Git, a bit a Ruby and you will get your local version of ceylon-lang.org served.

Prerequisites

Get Git
Get Ruby > 2.1
If on Mac OS:
- Get XCode (needed for compilation of native gems)
If on Linux:
- Get libxslt-dev - eg via sudo apt-get install libxslt-dev (may be called libxslt1-dev for some distros)

Install Git to your system. GitHub's help page is a good starting point. Emmanuel's blog on Git tips and tricks is useful too.

Installation

Ensure Rake is installed

Make sure Rake is available. It is often installed per default.

rake --version

If you get "command not found":

gem install rake

Ensure Bundler is installed

Make sure Bundler is available. It manages your Ruby gems locally to the project and prevents version conflicts between different Ruby projects. To quote from the website:

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed.

bundle -v

If you get "command not found":

gem install bundler

Get the source

git clone [email protected]:ceylon/ceylon-lang.org.git
cd ceylon-lang.org

Setup awestruct

rake setup
rake check

Note that on existing installs, you might see the following error

/Users/alice/.rvm/rubies/ruby-2.1.2/lib/ruby/2.1.0/rubygems/dependency.rb:298:in `to_specs': Could not find 'bundler' (>= 0) among 8 total gem(s) (Gem::LoadError)
        from /Users/alice/.rvm/rubies/ruby-2.1.2/lib/ruby/2.1.0/rubygems/dependency.rb:309:in `to_spec'
        from /Users/alice/.rvm/rubies/ruby-2.1.2/lib/ruby/2.1.0/rubygems/core_ext/kernel_gem.rb:53:in `gem'
        from /Users/alice/.rvm/gems/ruby-2.1.2/bin/bundle:22:in `<main>'
        from /Users/alice/.rvm/gems/ruby-2.1.2/bin/ruby_executable_hooks:15:in `eval'
        from /Users/alice/.rvm/gems/ruby-2.1.2/bin/ruby_executable_hooks:15:in `<main>'
rake aborted!

It is due to a partial or corrupt installation of the bundles that you need to clear. Do either of these operations:

rake clean[all]
# if that fails, do
rm -fR .bundle _tmp _bin

Then run the rake setup command again.

Serve the site locally

rake preview

Point your browser to http://localhost:4242

Any change will be automatically picked up except for _partials files, _base.css and sometimes new blog entries.

Which other tasks exist in the Rake build file?

rake --tasks

This will list the available tasks with a short description

How to also include the spec and `ceylon doc` pages

Is that obsolete?

Use ./build-site.sh. This will clone or refresh the spec, language and compiler repos into _tmp and build the appropriate artifacts before pushing them to the site.

If you have already run ./build-site.sh and don't wish to rebuild the spec and ceylondoc, use

./build-site.sh --light

to simply copy them to the website structure. This is much faster.

If your changes are not visible...

Panic! Then completely regenerate the site via:

rake clean preview

If serving the site is slow...

On Linux, serving the file may be atrociously slow (something to do with WEBRick).

Use the following alternative:

Go in your ~/ceylon-lang.org directory.
Run rake gen
In parallel, go to the ~/ceylon-lang.org/_site directory
Run python -m SimpleHTTPServer 4242

You should be back to millisecond serving :)

License

The content of this repository is released under Creative Commons Attribution Share-Alike 3.0 Unported (CC BY-SA 3.0). Sample code available on this website is released under Apache Software License 2.0.

By submitting a "pull request" or otherwise contributing to this repository, you agree to license your contribution under the respective licenses mentioned above.

Acknowledgements

This website uses:

Icons from Komodo Media, Rogie King (CC BY-SA 3.0 with link back to the creator)

ceylon-lang.org's People

Stargazers

Watchers

ceylon-lang.org's Issues

Update tour to use more compact syntax for control structures

All through the tour we have stuff like "if (exists String name = person.name)", "try (Session s=Session())" and "for (Person p in people)". We should prefer the new shorter form: "if (exists name = person.name)", "try (s=Session())" and "for (p in people)".

Website footer should be centered

Bug in syntax highlighter

If seems to be confused with /**/ comments, see http://localhost:4242/documentation/reference/statement/if/

Link to PDF does not work as it contains the creation day

eg http://localhost:4200/documentation/spec/pdf/Ceylon%20Language%20Specification%2020111104.pdf

Tour: XXX

In the tour there are missing links, generally marked XXX, to stuff originally posted on in.relation.to. These should be fixed

Write quick introduction guide or get rid of it

/documentation/introduction/ is simply pointing to the tour today,

We need to decide the top 5 features we want to show in the quick tour.
Remember the quick tour is only 1 page long and should interest people to find more information.

Write doc on how to install and run Ceylon's release

Open the development mailing list

Add FAQ entry about short syntax for attribute assignment in constructor

See development mailing list and email from Gavin

documentation/tour/functions/ has lots of typos/formatting problems

We need to go over this page and fix little formatting issues.

Blogs atom feed URLs do not work

Urls from atom feed end in .html which causes 404

eg.

current atom url:
http://ceylon-lang.org/blog/2011/11/17/welcome.html

working:
ceylon-lang.org/blog/2011/11/17/welcome/

Make sure language module code in tour is uptodate

Here, for example:

http://ceylon-lang.org/documentation/tour/sequences/

There is code copied from the language module. Which is probably now outdated. Update it.

Tour: Intersection types

They deserve a mention at least

Write script to publish spec in the website /documentation/spec

open the ceylon repositories

.../interoperability/annotations gives a 404

It is linked to from /documentation/reference/ at the bottom under Interoperability.

Get rid of the reference/ceylon.language pages

Once ceylon/ceylon-compiler#175 has come to a conclusion about the URLs, get rid of the reference/ceylon.language pages and link directly to the ceylond output instead.

IDE screenshots

We need screenshots of the IDE.

Review the site, spot and eliminate errors or outdated info

Link on http://ceylon-lang.org/documentation/faq/ not working

The link titled with "how to work on that project" within the "Contributing" section doesn't work.

Migrate to the new skin (logo + CSS)

Waiting for work to decant on James side. This is a work done by @gavinking, @emmanuelbernard and @insectengine

Prepare the machine to host ceylon-lang.org

This includes at least

get finance to finish the PO
get @bobmcwhirter set the machine up and give root access to @emmanuel
get the DNS to point to it
get Apache to answer the site
get the Git pull script to update the site live

Write a welcome blog explaining the website release

Linking to the spec and API doc

We need to link to the spec and API doc from the awestruct generated site. If we can agree what the URL will be we can write docs now even in the absence of these.

Trim the size of the bamboo background

We should somehow try to get the size down, it's a 560KB image (which somehow often does not get cached) and I can see it load on my 20Mb connection.
Maybe we can make it less wide (1500px is a lot) and make it repeat with some clever photoshop trickery?

Find a mechanism to not publish test data when we go live

Blogs are full of not so interesting information. Decide what to do with it.

The FAQ link on the left menu is hard to read

At http://ceylon-lang.org/documentation/ it's hard to read FAQ on the left menu, we read FAO due to the font and underline

Write script to copy ceylond's output in /documentation/api

Tour: Work transcluded sections into the body text

When I initially copied the tour from in.relation.to I also copied in some of the related posts, e.g. anonymous functions, and (un)currying. These need editing to ensure that what's documented is what's actually been implemented, and the content needs to be worked into the main body of the tour. Search for 'transcluded' to find where I've done this.

We also need to consider adding content for other posts which I missed.

/blog page displays "0 comments" even when there are comments

I did not even realize there were comments on this entry:

http://ceylon-lang.org/blog/2011/11/17/welcome/#disqus_thread

Put a caching strategy in place

Use .htaccess / apache capabilities

Safe things to cache are images and with a lower expiration CSS.
Actual content is more dangerous so I'd rather not do it initially.

Work on contribution FAQ

Mention the blog in the news section

It need to be in the home page for a while until we have a release

Fix a few mistakes on /documentation/tour/missing-pieces/

we should upate the chapter 8 of "Tour on Ceylon" (http://www.ceylon-lang.org/documentation/tour/missing-pieces/) cauz of the "shared" annotation on a setter. The tutorial mentioned the annotation but when u try to compile such a code you'll get an compile error: setters may not be annotated shared

Markdown syntax in title

If you use some markdown syntax in an awestruct page title then that syntax is apparent in the HTML <title>. See http://localhost:4242/documentation/reference/statement/throw/ for an example. Having consulted the HAML reference I can't see how this can be fixed without using a custom HAML filter to extract the text content of the XHTML of the rendered markdown.

atomizer.rb (and multiatomizer.rb)
template.atom.haml and author_template.atom.haml

Write teaser page about the IDE

Some screenshot
what it does

Add a user forum to the website

Clarify how to build ceylon-lang.org on Windows systems

A user is having problem installing Awestruct on Windows, let's try and smooth this process

Here is the feedback

I read the instructions on https://github.com/emmanuelbernard/ceylon-lang.org

I downloaded ruby for Windows from http://rubyinstaller.org/

I downloaded awestruct from http://rubygems.org/gems/awestruct

gem install awestruct-0.2.10 I get the following error:
ERROR: Error installing awestruct-0.2.10: The 'hpricot' native gem requires installed build tools. Please update your PATH to include build tools or download the DevKit from 'http://rubyinstaller.org/downloads' and follow the instructions at 'http://github.com/oneclick/rubyinstaller/wiki/Development-Kit'

I downloaded hpricot from http://rubygems.org/gems/hpricot

gem install hpricot-0.8.5 I get the following error:
ERROR: Error installing hpricot-0.8.5: The 'hpricot' native gem requires installed build tools. Please update your PATH to include build tools or download the DevKit from 'http://rubyinstaller.org/downloads' and follow the instructions at 'http://github.com/oneclick/rubyinstaller/wiki/Development-Kit' Please,

Could you show me if i followed the steps correctly and i made the downloads right?, and How i correct this error to build ceylon-lang.org?

http://ceylonlang.disqus.com/httplocalhost4242blog20111117welcome/latest.rss

As reported here.

Add unique_identifier in Disqus integration

Check

the Awestruct native disqus plugin and
http://docs.disqus.com/help/2/

thanks for Christian for pointing it out