This document should be created, presented, discussed and approved by TSC before M0 of the particular release. It should contain as much detailed as possible definition of what is planned within the nearest release to be accomplished.

1. Introduction

Purpose of the document

2. Problem statement

Currently, the website is hard to use by new users. Content is stored under three domains (github pages, docs and main domain), description is hard to consume and the website is not mobile friendly. It doesn't help users to get involved with TF.

It is also not stored in the official TF repos so it is hard for anyone to contribute to the project. 

3. Proposed solution

The tasks of creating a new website should include:

  • Define personas that will mirror real TF users (user, developer, contributor)
  • Prepare new information architecture
  • Inspect current content and fill any gaps
  • Create new designs in accordance with brand guide
  • Create new designs using mobile first approach
  • Create consistent design for documentation and presentation
  • Create mobile friendly versions of images
  • Create a page using Gatsby static page framework to get high page load speed score
  • Store all content in publicly available repository
  • Create Jenkins pipeline that will build website
  • Create documentation of how to maintain the website

3.1 Affected Modules

None

3.2 Alternatives considered

Alternative would be to continue working on the current website. The cost of doing that would be identical as most work will be done from scratch.

3.3 API schema changes

None

3.4 User workflow impact

The workflow for admin user who will be able to publish new materials will be changed. It will follow normal Github workflow.

3.5 UI changes

None

3.6 Operations and Notification impact

None

4. Implementation

4.1 Assignee(s)

Szymon Golebiewski - PM

Piotr Bogucki - UX

### - UI

### - DevOps

4.2 Work items

Changes will be done only in the code of the website.

5. Performance and scaling impact

5.1 API and control plane

n/a

5.2 Forwarding performance

n/a

6. Upgrade 

n/a

7. Deprecations

n/a

8. Dependencies

n/a

9. Testing

9.1 Unit tests

9.2 Dev tests

9.3 System tests

10. Documentation Impact

New documentation will be done:

  1. How to pubslih new materials.
  2. How to build new version.
  3. How to develop website code.
  4. Project dependencies.

11. References


  • No labels