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

Add Blog #639

Open
wants to merge 22 commits into
base: develop
Choose a base branch
from
Open

Add Blog #639

wants to merge 22 commits into from

Conversation

mpeiffer
Copy link

@mpeiffer mpeiffer commented Oct 5, 2020

Context

Summary of Changes

  • Added a new /blog directory containing all relevant blog code
  • Added a landing page for the blog that automatically updates and creates a link when a new blog post is created
  • Added a README.md containing instructions to launch the blog and write posts
  • Added a link to the blog and short description in the main README.md
  • Added a test blog post

Checklist

  • Tested Mobile Responsiveness
  • Added Unit Tests
  • CI Passes
  • Deploys to Heroku on test Correctly (Maintainers will handle)
  • Added Documentation (Service and Code when required)

Screenshots

landing_page
test_blog_post

Add the landing page for the blog
Changed post link to include the /blog directory
Removed duplicate /blog directory
Moving back into /blog directory
Moved back into /blog directory from main directory
Added blog link to README.md

NOTE: Link will only work after setting up GitHub pages for the repository.

To use a custom domain name, navigate to the repository settings, and under GitHub pages enter the desired name. Then, update the readme link to be: https://custom-domain-name/refugerestrooms/blog/
Switching over to the default Jeykll themes, CSS is obsolete.
Switching over to default Jekylll themes, CSS is obsolete.
Switching over to default Jekylll themes, CSS is obsolete.
Added instructions to host the blog using GitHub pages
@DeeDeeG
Copy link
Contributor

DeeDeeG commented Oct 6, 2020

Hi, thanks for this. Will take a closer look when I get the chance, but just wanted to let you know I've seen this.

The screenshots look pretty reasonable! And at first look, so does all the code and such.

I'll ping some of the other maintainers and see if they have any thoughts about blog posts. I suppose I could post some things myself from the perspective of maintaining the project and what's been up lately around this repository. I wonder what people would be most interested in? (Or what, amongst ourselves, the maintainers would most want to put out there?)

But this has been on the to-do list for a while, so I'm glad to see an implementation that can be put to use pretty much immediately if/when we want to post something.

Best regards,
- DeeDeeG

@DeeDeeG DeeDeeG added Community Update Hacktoberfest These are issues or pull requests related to Hacktoberfest (https://hacktoberfest.digitalocean.com/) Ready for Review labels Oct 6, 2020
@mpeiffer
Copy link
Author

mpeiffer commented Oct 6, 2020

Glad to help! Please let me know if there's anything that needs editing when you get the chance to look over it.

@mi-wood
Copy link
Member

mi-wood commented Oct 14, 2020

Hi @mpeiffer , thanks for the PR! It would be great to have a blog again.

Is there any way to host this from the main app instead of github.io? It would be nice to serve it from refugerestrooms.org/blog rather than another domain/site. I'm not up to date with rails blog knowledge, but I imagine there's a way to serve it there as a route.

@mpeiffer
Copy link
Author

Hi @mi-wood! I think that would be possible. You would need to go to the repository settings, and the under the github pages settings, enter refugerestrooms.org/blog as the domain name instead of the default domain name.

@@ -0,0 +1,15 @@
!DOCTYPE html>
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi, sorry it has taken so long to give this a technical review.

There is a small typo. I think this is missing a left bracket <.

!DOCTYPE html> <!DOCTYPE html>

blog/index.html Outdated
<p>REFUGE restrooms indexes and maps safe restroom locations for trans, intersex, and gender nonconforming individuals.</p>
<ul class="posts">
{% for post in site.posts %}
<li><span>{{ post.date | date_to_string }}</span> » <a href="/refugerestrooms{{ post.url }}" title="{ post.title }}">{{ post.title }}</a></li>
Copy link
Contributor

Choose a reason for hiding this comment

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

There is apparently a missing left bracket here:

title="{ post.title }}" --> title="{{ post.title }}"

Copy link
Author

Choose a reason for hiding this comment

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

I'll fix these as soon as possible.

@DeeDeeG
Copy link
Contributor

DeeDeeG commented Oct 28, 2020

Thanks for the updates. I plan to "approve" this pull request, or mark it as "hacktoberfest-accepted", because it has genuinely helped with considering the GitHub Pages option for the blog in a concrete way. (That would make this pull request count toward the Hacktoberfest number of pull requests, if you're participating in that event.) I would plan to do that since this pull request has been genuinely helpful, but there would be some difficulty merging it here. (And because some additional discussion with the other maintainers would be good before activating this).


Some notes:

I've been trying to get this code up and running in a "test" sort of way. (Here: https://github.com/DeeDeeG/test_refugerestrooms_blog/ --> https://deedeeg.github.io/test_refugerestrooms_blog/)

As far as I can tell, GitHub only lets you activate a GitHub Pages site from the main (root) folder, or the docs subfolder.

GitHub Pages settings view, focusing a "select folder" dropdown that shows only the "/ (root)" and "/docs" options available.

The root folder should be neat and tidy for this repository (for the main web app) in my opinion, and the docs/ subfolder doesn't really fit for a blog, so I think if we use GitHub Pages, we will do so in a separate repository from this one (RefugeRestrooms/refugerestrooms).

I've looked into changing the theme and all that. And I've reviewed how to make a new blog post, from the documentation you linked to. Seems doable.

Thanks for this!

P.S.: in order to make this pull request into a separate repository, I cloned your fork to my local computer, then separated out the blog subfolder of this pull request's branch into its own, separate branch, following these instructions: https://stackoverflow.com/questions/359424/detach-move-subdirectory-into-separate-git-repository/17864475#17864475. Then I pushed that to my DeeDeeG/test_refugerestrooms_blog/ repository here on GitHub, then activated GitHub Pages in the settings of that repository.

P.P.S. if you prefer your code not be hosted that way in the test repository I made, please do let me know and I can delete that repository, or if you prefer the code hosted at the main RefugeRestrooms organization, I can do that. I don't want to move people's code around in ways that are unexpected, so I have absolutely no problem moving or deleting that test repo in whatever way you would request.

@mpeiffer
Copy link
Author

mpeiffer commented Oct 28, 2020

I think that it makes sense to put it into it's own repository, so I don't mind where you host the code. Thank you for adding the Hacktoberfest label!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community Update Hacktoberfest These are issues or pull requests related to Hacktoberfest (https://hacktoberfest.digitalocean.com/)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a new blog
3 participants