Add guideline pages #42
Comments
|
render in path:
|
|
Example directory: Download Example screenshot:
One thing to consider is to how to determine URLs from this convention.
could be rendered in the following path:
The one above might be a better approach than deriving these 2 kinds of URL paths from metadata files and Markdown titles. |
dimanyc
added a commit
that referenced
this issue
Apr 17, 2020
Closes #42 This PR handles adding guideline resources are described in #42. To follow the requested URL structure (comment: #42 (comment)), an default locale of `en` is introduced and used as a scope in routes, to ensure that `/en/guidelines` and `/guidelines` route default to the same resource Because `guidelines` are ephemeral, a presenter is used to display initial guidelines that have guideline categories that, in turn, have many articles. Presenters also take care of fetching and rendering metadata stored in YML files TODO: - add markdown parsing / rendering based on https://github.com/panvol/pandemic-volunteers/pull/44/files#diff-e55a6c615d18aeb75e0610b835b16658 - make methods such as `GuidelineCategory.extract_slug` etc., metadata file fetching and loading, and loading dirs via `Pathname` reusable. This is because GuidelineCategory and GuidelineArticle will be sharing 90% of their methods. GuidelineArticle will also need to be able to load its own metadata - move `GuidelinesPresenter` to `app/models` since `GuidelineCategory` is very similar and acts as a stand-in for a model - add designs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Pages
The index page
/guidelinesCan have guideline category pages in the following format:
In a card form with the following contents:
Inspirations
Guideline category pages
/guidelines/:categoryCan have a list of the guidelines in the category.
Should have its attributes that're seen on the parent page visible as well. Such as:
Inspirations
Guideline pages
/guidelines/:category/:titleShould render a markdown.
Inspirations
Routes
The following routes should be reachable:
/guidelines/guidelines/:category/guidelines/:category/:title:categoryOne of the following:
Notes
For images, the following graphics could be used.
Common:
undraw_reading_0re1.svgin https://www.notion.so/Assets-04b473617ece497291aa7fbff4b8d912Others: The same images used on the landing page.
:titleURL should be in hyphen-separated case aka kebab-case.
Example route
/guidelines/elderly-crews/role-definition
Design considerations
Linking
In the top bar, we could remove the FAQ link and put a "Guidelines" link instead.
The text was updated successfully, but these errors were encountered: