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

Chore: Convert community article markdown to html #3284

Merged
merged 1 commit into from
Sep 18, 2022

Conversation

rlmoser99
Copy link
Member

Complete the following REQUIRED checkboxes:

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this PR follows the keyword: brief description of change format, using one of the following keywords:
  • Feature - adds new or amends existing user-facing behaviour
  • Chore - changes that have no user-facing value, refactors, dependency bumps, etc
  • Fix - bug fixes

Complete the following checkbox ONLY IF it is applicable to your PR. You can complete it later if it is not currently applicable:

  • I have verified all tests and linters pass against my changes, and/or I have included automated tests where applicable

1. Because:
Using html we can apply unique styles to these community articles
Related to Community Landing Page feature

2. This PR:

  • Removes the community expectations markdown file
  • Converts it to html and applies some basic styling

3. Additional Information:
I wanted to start with converting one file, since they will share the majority of styling. Then I'll take any changes that we decide on and apply them to the other 3 community pages (that have already been converted).

Copy link
Member

@KevinMulhern KevinMulhern left a comment

Choose a reason for hiding this comment

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

Nice work @rlmoser99 💪

I have a few suggestions based on what we've been doing with TW. But overall, this looks great.

@@ -1,11 +1,87 @@
<%= title('Community Expectations') %>
<% filename = 'app/views/static_pages/dashboard_steps/community_expectations.md' %>
<div class="gradient py-8">
Copy link
Member

Choose a reason for hiding this comment

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

We have a page-container that be used here. It will give us consistent spacing between navbar/footer and content for all pages.

Suggested change
<div class="gradient py-8">
<div class="page-container">

@@ -1,11 +1,87 @@
<%= title('Community Expectations') %>
<% filename = 'app/views/static_pages/dashboard_steps/community_expectations.md' %>
<div class="gradient py-8">
<div class="col-xl-8 offset-xl-2 text-gray-500">
Copy link
Member

@KevinMulhern KevinMulhern Sep 11, 2022

Choose a reason for hiding this comment

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

To keep the same content styling throughout the site, we can add these classes to this container div:

Suggested change
<div class="col-xl-8 offset-xl-2 text-gray-500">
<div class="lesson-content prose prose-lg prose-gold max-w-prose mx-auto">

After-which, We can remove all the individual classes on headings, paragraphs and lists within the container.

We encourage questions, so do not worry about asking a “stupid question”. However, it is important that you know <a href="/before_asking" class="text-gold-600 underline decoration-solid" target="_blank">How to Help Yourself Before Asking Others</a> and follow our tips on <a href="/how_to_ask" class="text-gold-600 underline decoration-solid" target="_blank">How to Ask a Technical Question</a>. In addition, to ensure that everyone has the same expectations, below are some specific guidelines on asking questions:
</p>

<div class="card-main">
Copy link
Member

Choose a reason for hiding this comment

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

With the prose classes applied, I think this looks and flows better without card styling
Screenshot 2022-09-11 at 14 24 19

Same for the other lists that are using card-main below.

@rlmoser99
Copy link
Member Author

Thanks for the suggestions @KevinMulhern, as I wasn't entirely sure how to implement the tailwind updates.

Do you have a preference if I should break up the really long lines for each paragraph? It makes it hard to view the files on github, but can use word wrap when using a code editor.

@KevinMulhern
Copy link
Member

No strong preferences @rlmoser99, I like to be more relaxed with line lengths in views.

I suppose we could break up some of the longer lines at natural breakpoints in the content. But totally up to you, it's by no means a blocker from me.

@KevinMulhern KevinMulhern temporarily deployed to theodinproject-pr-3284 September 16, 2022 22:46 Inactive
@KevinMulhern KevinMulhern temporarily deployed to theodinproject-pr-3284 September 17, 2022 02:17 Inactive
Copy link
Member

@KevinMulhern KevinMulhern left a comment

Choose a reason for hiding this comment

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

Nice work @rlmoser99, looks great 🏆

Before merging can we squash the commits into one please?

@KevinMulhern KevinMulhern added the Type: Enhancement Involves a new feature or enhancement request label Sep 18, 2022
Because
- Using html we can apply unique styles to these pages

This
- Removes the community expectations markdown file
- Converts it to html and applies some basic styling
@rlmoser99 rlmoser99 force-pushed the chore/update-community-expectations branch from 65c1827 to e7497ad Compare September 18, 2022 18:51
@KevinMulhern KevinMulhern temporarily deployed to theodinproject-pr-3284 September 18, 2022 18:51 Inactive
@rlmoser99 rlmoser99 merged commit 051c033 into main Sep 18, 2022
@rlmoser99 rlmoser99 deleted the chore/update-community-expectations branch September 18, 2022 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement Involves a new feature or enhancement request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants