-
Notifications
You must be signed in to change notification settings - Fork 5
Open
Labels
technical storyNew technical feature or request, yielding value to contributors, indirectly perceived by end-usersNew technical feature or request, yielding value to contributors, indirectly perceived by end-users
Description
Preparation
You'll probably already defined values for the following main placeholders, before forking the template repository:
- Figure out a title for the new website ⟶
‹SITE-TITLE›; for instance,Dating PrivacyTODO - Figure out a name for the new website ⟶
‹SITE-NAME›; for instance,dating-privacyTODO - Figure out a two letters short name for the new website ⟶
‹SITE-SHORTNAME›; for instance,dpTODO - Figure out a name for the new repository ⟶
‹REPO-NAME›; for instance,website.dpTODO
Derived names:
-
‹REPO-PACKAGE-NAME›⟵website-‹SITE-SHORTNAME›package name for the new repository, used inpackage.json_; same as ‹REPO-NAME›, but with dash instead of dot:website-dp -
‹NEWSLETTER-FORM-NAME›⟵newsletter-‹SITE-SHORTNAME›-signupname of the Netlify Form to which newsletter subscriptions will be submitted to -
‹CONTACT-FORM-NAME-INFO›⟵contact-‹SITE-SHORTNAME›-info -
‹CONTACT-FORM-NAME-MEDIA›⟵contact-‹SITE-SHORTNAME›-media -
‹CONTACT-FORM-NAME-PARTNERS›⟵contact-‹SITE-SHORTNAME›-partners -
‹CONTACT-FORM-NAME-RESEARCHERS›⟵contact-‹SITE-SHORTNAME›-researchers
Optional at this stage, but have to be defined before site public launch:
- Decide an URL for the new website ⟶
‹SITE-URL›to be reserved in Gandi and used in Netlify; for instance,your-showcase.hestialabs.org - Get the Netlify Site UUID ⟶
‹SITE-UUID›used inREADME.md - Decide who'll be the owner of the community ⟶
‹SITE-OWNER-NAME›used inpackage.json:Charles Foucault-Dumas - Decide a Twitter account name linked to the new website ⟶
‹TWITTER-ACCOUNT-NAME› - Decide an URL for the forum linked to the new website ⟶
‹FORUM-SITE-URL›
Actions
Following the above mentioned instructions, you probably already…
— however please fill in the date and your initials after the DONE statuses —
- Forked the WEBSITE.TEMPLATE repository to this one
DONE - Edited the
README.md, updated the first‹SITE-TITLE›placeholder, with the title of the new website, and removed the blockquoted comments preceding the titleDONE - Updated the description in the repository details (
HestiaLabs ‹SITE-TITLE› websiteusually)DONE - Updated the tags in the repository details (please set
communityandwebsitesat minimum)DONE - Updated the Website URL in the repository details (
‹SITE-URL›.hestialabs.orgusually)DONE
Initial setup, within the new forked repository
- Edit
package.jsonand replace all occurrences of the‹REPO-NAME›placeholder with the name of this repositoryTODO - Similarly, replace the
REPO-PACKAGE-NAMEplaceholder inpackage.jsonwith a dashed version of the‹REPO-NAME›(e.g.website.dp⟶website-dp)TODO - Finally, replace the
‹SITE-NAME›and‹SITE-OWNER-NAME›placeholders inpackage.json - Optionally, update the list of contributors in
package.json - Update the urls for
homepage,bugsandrepositoryinpackage.jsonTODO - Run
npm installon the command-lineTODO - Commit your changes to
package.jsonand the updatedpackage-lock.jsonTODO
Basic configuration
- Review the redirect rules in
netlify.toml, update them according to your needs and commit your changesTODO - Review search engine disallow rules in
robots.txtand update them if neededTODO - Review the contents of the splash landing page and replace the
‹SITE-TITLE›placeholder insrc/site/index.htmlTODO - Review the contents of the Web App Manifest and replace the
‹SITE-TITLE›placeholder insrc/site/manifest.jsonTODO - Commit your changes
TODO
Netlify Hosting setup
- follow doc about setting up a netlify website
TODO - Take the value of
‹SITE-UUID›on tab Site settings, API IDTODO
After finishing the Netlify site setup, within the new forked repository
- Update the ‹Netlify Status› badge on first line of the
README.md; replace the‹SITE-UUID›and‹SITE-NAME›placeholders with adequate valuesTODO[](https://app.netlify.com/sites/‹SITE-NAME›/deploys)
- Finally, replace every occurrence of the
‹SITE-URL›placeholder inREADME.mdTODO - Similarly, replace every other occurrence of the
‹SITE-NAME›and‹SITE-TITLE›placeholders inREADME.mdTODO - Commit your changes to
README.mdTODO - Setup Netlify Large Media for the new repository
TODO - Edit, remove comments, save and commit the updated
.lfsconfigfile, that the above Netlify LM setup createdTODO
Theme configuration
- Define the primary theme color
TODOtemplate defaults to#04650f - Define the secondary theme color
TODOevaluateLightenDarkenColor( "#‹primary color›",224) - Set the primary theme color in the
--theme-color-primaryCSS variable insrc/assets/styles/main.cssTODO - Set the secondary lightened theme color in the
--theme-color-secondaryCSS variable insrc/assets/styles/main.cssTODO - Set the primary theme color in the
style="fill:rgb(4,101,15);"CSS rule insrc/site/favicon.svg(<path>element on line 9)TODO - Set the primary theme color in the
fill="#04650f"SVG attribute insrc/assets/img/icon-external-link.svg(<path>element on line 3)TODO - Update the
‹SITE-TITLE›placeholders in the samesrc/site/favicon.svgTODO - Update the
‹SITE-TITLE›and‹SITE-NAME›placeholders in thesrc/assets/img/placeholder-logo-web-*.svgSVG documentsTODO - Update the
‹SITE-TITLE›placeholder insrc/site/_includes/header.njkTODO - Commit your changes
TODO
TODO update logo
Configure newsletter sign-up form
- Update the
‹NEWSLETTER-FORM-NAME›placeholder inconf/netlify/forms/newsletter-signup-form-def.htmlTODO - Similarly, update the
‹NEWSLETTER-FORM-NAME›placeholder insrc/site/_layouts/{blog,home,infographic,post}.htmlTODO
TODO
Configure contact forms
- Update the
‹CONTACT-FORM-NAME-INFO›placeholder insrc/site/contact/{en,fr}/info.mdTODO - Update the
‹CONTACT-FORM-NAME-MEDIA›placeholder insrc/site/contact/{en,fr}/media.mdTODO - Update the
‹CONTACT-FORM-NAME-PARTNERS›placeholder insrc/site/contact/{en,fr}/partners.mdTODO - Update the
‹CONTACT-FORM-NAME-RESEARCHERS›placeholder insrc/site/contact/{en,fr}/researchers.mdTODO
Cleanup
- Perform a global search & replace for the
‹SITE-TITLE›,‹SITE-NAME›,‹SITE-SHORTNAME›,‹SITE-URL›and‹SITE-UUID›placeholders in all files of the website and correct those remaining onesTODOdid you leave it untouched in thesrc/site/favicon.svg? did you change the social URLs insrc/site/_data/links.json? - Perform a global search & replace for the
‹REPO-NAME›and‹REPO-PACKAGE-NAME›placeholders in all files of the website and correct those remaining onesTODOdid you leave it untouched in thepackage.json?
Hand-over to site owner
Configure canonical URL and social network links
- Update the
‹SITE-URL›placeholder insrc/site/_data/links.jsonTODOused in all pages, important for SEO - Update the
‹FORUM-SITE-URL›placeholder insrc/site/_data/links.jsonandsrc/site/community/{en,fr}/index.mdTODO - Update the
‹TWITTER-ACCOUNT-NAME›placeholder insrc/site/_data/links.jsonandsrc/site/community/{en,fr}/index.mdTODO
TODO configure blog (authors, categories)
TODO edit blog contents (editorials, infographics, interviews)
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
technical storyNew technical feature or request, yielding value to contributors, indirectly perceived by end-usersNew technical feature or request, yielding value to contributors, indirectly perceived by end-users