Skip to content

Finishing setup of forked repository #1

@olange

Description

@olange

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 Privacy TODO
  • Figure out a name for the new website ⟶ ‹SITE-NAME›; for instance, dating-privacy TODO
  • Figure out a two letters short name for the new website ⟶ ‹SITE-SHORTNAME›; for instance, dp TODO
  • Figure out a name for the new repository ⟶ ‹REPO-NAME›; for instance, website.dp TODO

Derived names:

  • ‹REPO-PACKAGE-NAME›website-‹SITE-SHORTNAME› package name for the new repository, used in package.json_; same as ‹REPO-NAME›, but with dash instead of dot: website-dp
  • ‹NEWSLETTER-FORM-NAME›newsletter-‹SITE-SHORTNAME›-signup name 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 in README.md
  • Decide who'll be the owner of the community ⟶ ‹SITE-OWNER-NAME› used in package.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 title DONE
  • Updated the description in the repository details (HestiaLabs ‹SITE-TITLE› website usually) DONE
  • Updated the tags in the repository details (please set community and websites at minimum) DONE
  • Updated the Website URL in the repository details (‹SITE-URL›.hestialabs.org usually) DONE

Initial setup, within the new forked repository

  • Edit package.json and replace all occurrences of the ‹REPO-NAME› placeholder with the name of this repository TODO
  • Similarly, replace the REPO-PACKAGE-NAME placeholder in package.json with a dashed version of the ‹REPO-NAME› (e.g. website.dpwebsite-dp) TODO
  • Finally, replace the ‹SITE-NAME› and ‹SITE-OWNER-NAME› placeholders in package.json
  • Optionally, update the list of contributors in package.json
  • Update the urls for homepage, bugs and repository in package.json TODO
  • Run npm install on the command-line TODO
  • Commit your changes to package.json and the updated package-lock.json TODO

Basic configuration

  • Review the redirect rules in netlify.toml, update them according to your needs and commit your changes TODO
  • Review search engine disallow rules in robots.txt and update them if needed TODO
  • Review the contents of the splash landing page and replace the ‹SITE-TITLE› placeholder in src/site/index.html TODO
  • Review the contents of the Web App Manifest and replace the ‹SITE-TITLE› placeholder in src/site/manifest.json TODO
  • Commit your changes TODO

Netlify Hosting setup

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 values TODO
    [![Netlify Status](https://api.netlify.com/api/v1/badges/‹SITE-UUID›/deploy-status)](https://app.netlify.com/sites/‹SITE-NAME›/deploys)
  • Finally, replace every occurrence of the ‹SITE-URL› placeholder in README.md TODO
  • Similarly, replace every other occurrence of the ‹SITE-NAME› and ‹SITE-TITLE› placeholders in README.md TODO
  • Commit your changes to README.md TODO
  • Setup Netlify Large Media for the new repository TODO
  • Edit, remove comments, save and commit the updated .lfsconfig file, that the above Netlify LM setup created TODO

Theme configuration

TODO update logo

Configure newsletter sign-up form

Configure contact forms

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 ones TODO did you leave it untouched in the src/site/favicon.svg? did you change the social URLs in src/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 ones TODO did you leave it untouched in the package.json?

Hand-over to site owner

Configure canonical URL and social network links

TODO configure blog (authors, categories)
TODO edit blog contents (editorials, infographics, interviews)

Metadata

Metadata

Assignees

No one assigned

    Labels

    technical storyNew technical feature or request, yielding value to contributors, indirectly perceived by end-users

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions