cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "C. Scott Andreas (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CASSANDRA-14552) Website: Add Static Blogging / Article Publishing to cassandra.apache.org
Date Sun, 01 Jul 2018 01:54:00 GMT

    [ https://issues.apache.org/jira/browse/CASSANDRA-14552?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16528956#comment-16528956
] 

C. Scott Andreas commented on CASSANDRA-14552:
----------------------------------------------

@[~djoshi3] Thanks for taking a look!

Can you try walking through the instructions in the README to build? I followed them to build
the website prior to making any changes to the repo and during development; they'd worked
on two machines for me. Paraphrasing the README: http://svn.apache.org/repos/asf/cassandra/site/src/README

– Install rbenv (an easy final step to miss is adding `eval "$(rbenv init -)"` to ~/.bash_profile.
– rbenv install 2.4.2
– rbenv local 2.4.2
– gem install jekyll:3.4.3 jekyll-paginate-v2
– make serve

Agreed that Dockerizing might make for an easier local development environment for the website.
I think that improvements to the build scripts and documentation would be a better fit for
proposal in a separate JIRA, though; I'd like to follow the existing build/development
process for this ticket rather than making changes to the build environment itself.

On that, I do appreciate how minimal the current build process is for the website. I might
be an outlier, but don't have Docker or bundler installed on my machines and smiled remembering
how simple Jekyll development felt ca. 2010 –– then again, I am also a dinosaur in many respects
:-). Would be interested to hear feedback from others who are interested in writing on what
makes contribution easiest (/cc [~jolynch]).

Re: the SVN repo, that's right – the website is stored in the SVN repo at the URL you shared.
Currently, the documentation for updating the website and contributing a post is in the README
of the repo itself (similar to CONTRIBUTING.md in the git repo).

> Website: Add Static Blogging / Article Publishing to cassandra.apache.org
> -------------------------------------------------------------------------
>
>                 Key: CASSANDRA-14552
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-14552
>             Project: Cassandra
>          Issue Type: Improvement
>          Components: Documentation and Website
>            Reporter: C. Scott Andreas
>            Assignee: C. Scott Andreas
>            Priority: Minor
>         Attachments: blog-post-listing.png, blog-post.png, blog.diff
>
>
> To make it easier for members of the community to share what's happening in Apache Cassandra,
advertise meetups, and publish other article-style content, this patch enables simple blogging
functionality via the static cassandra.apache.org site.
>  
> *How does it work?*
> The patch uses Jekyll's built-in static blog functionality to add article-style publishing.
It adds no dynamic content, and does not include commenting or a mechanism for accepting
any user-generated content. It makes the following changes:
> – Adds a new layout file for a blog post listing and single-post detail view (+ supporting
CSS).
>  – Enables pagination of posts via `jekyll-paginate-v2`
>  – Adds documentation on how to contribute.
>  – And fixes a minor documentation issue specifying a Ruby version that conflicts with
earlier guidance in the documentation.
>  
> *How do I write a post?*
> The patch includes a /_templates folder with an example post to begin. Blog posts are
written using Markdown. To write a new post, copy the template into /_posts, rename the file
in keeping with the `MM-DD-YYYY-blog-post-slug.markdown` convention, add the title/date,
and begin writing.
> These pages are generated via the existing build process documented in the README –
`make serve` to preview, `make` to publish.
>  
> *What else should I know?*
> The aim of this patch is to make it easy to write and publish. The "/blog" link is currently
hidden from the top nav and no posts are included in this patch, but this can be enabled
once the first article is ready.
>  
> *What's it look like?*
> Screenshots of the generated post list view and single-post view attached.
> !blog-post-listing.png|width=592,height=619!
>  
> !blog-post.png|width=592,height=619!



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org


Mime
View raw message