Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SOLR-16833: Add blog to Solr website #97

Merged
merged 4 commits into from
Apr 29, 2024

Conversation

gerlowskija
Copy link
Contributor

This commit introduces a new top-level section to the Apache Solr website: a blog.

The blog homepage (/blog.html) consists of:

  • a short intro/welcome
  • a link to contribution instructions
  • and then a list of blog post titles+links+snippets

Blog posts themselves are put in the content/pages/blogposts directory, and use a similar naming convention as we've already established for news items (ie. YYYY-MM-DD-article-title-slug.md). Unlike "news" items though, blog posts are compiled into proper HTML pages with their own URL.

This commit contains two stub blog posts. These are intended purely as placeholders, and should be replaced before going live with the "Blog" section of the site.

Still TODO (but not necessarily needed to merge)

  • Add docs to guide users through blog-post contribution. (Might be easier once we have an example PR or two to refer back to?)
  • produce an RSS or ATOM feed

This commit introduces a new top-level section to the Apache Solr website:
a blog.

The blog homepage (`/blog.html`) consists of:
  - a short intro/welcome
  - a link to contribution instructions
  - and then a list of blog post titles+links+snippets

Blog posts themselves are put in the `content/pages/blogposts`
directory, and use a similar naming convention as we've already
established for news items (ie. `YYYY-MM-DD-article-title-slug.md`).
Unlike "news" items though, blog posts are compiled into proper HTML
pages with their own URL.

This commit contains two stub blog posts.  These are intended purely as
placeholders, and should be replaced before going live with the "Blog"
section of the site.

Still TODO (but not necessarily needed to merge)
  - Add docs to guide users through blog-post contribution.  (Might be
    easier once we have an example PR or two to refer back to?)
  - produce an RSS or ATOM feed
@gerlowskija
Copy link
Contributor Author

I wanted to let this sit a nice long time, as it's a big change to our website. But it's been at least a month, and the bit of feedback this did get was positive! So I'll look to commit sometime soon (maybe later this week?)

The main thing still TBD is to create a non-"Lorem Ipsum" blog to be our inaugural post. At the risk of being too "meta", maybe the first post could announce the blog, discuss the rationale, and describe how to contribute/submit posts. Pending other suggestions I'll write this up and submit for review this week.

@dsmiley
Copy link
Contributor

dsmiley commented Apr 8, 2024

the first post could announce the blog, discuss the rationale, and describe how to contribute/submit posts

+1 perfect

@gerlowskija
Copy link
Contributor Author

gerlowskija commented Apr 24, 2024

Alright, it took me longer than expected to get the first few posts written, but I finally have those done. As things stand right now, when we merge this we'll launch with two posts:

  • a bit of an explainer behind the motivation for starting a blog, and
  • a Walkthrough/Tutorial showing how to write and propose a blog post.

Neither of them will win the Pulitzer, but "meta" posts are hard, and they're a start. Would love some review on these if anyone has a few minutes to give them a look!

Copy link
Contributor

@epugh epugh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@gerlowskija gerlowskija merged commit 82be265 into apache:main Apr 29, 2024
@gerlowskija gerlowskija deleted the SOLR-16833-prototype-blog-page branch April 29, 2024 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants