Versions Compared

Old Version 1

changes.mady.by.user Szymon Golebiewski

Saved on

compared with

New Version 2

changes.mady.by.user Szymon Golebiewski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Purpose of the document

  • Blueprint/Feature Lead: contact to the nominated person Szymon Golebiewski
  • Core team: contacts to the core team members
  • JIRA EPIC: 
    Jira
    serverTungsten Fabric
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId82691efe-91a0-3cff-8e71-932ce5d4700b
    keyTFF-17

2. Problem statement

Description of the problem, the requirement being solved for new or existing features. Use cases

3. Proposed solution

...

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

Affected modules form the agreed list of Modules and components - this will also define the list of approvers for the blueprintNone

3.2 Alternatives considered

Describe the pros and cons of alternatives consideredAlternative 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

Describe API schema changes and impact to the REST APIs.None

3.4 User workflow impact

Describe how users will use the featureThe 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

Describe any UI changesNone

3.6 Operations and Notification impact

Describe how to operate the feature, describe the operational impact, describe any log, UVE, alarm changesNone

4. Implementation

4.1 Assignee(s)

Szymon Golebiewski - PM

Piotr Bogucki - UX

### - UI

### - DevOpsList dev and test assignments

4.2 Work items

Describe changes needed for different components such as Controller, Analytics, Agent, UI. Add subsections as needed.Changes will be done only in the code of the website.

5. Performance and scaling impact

5.1 API and control plane

Scaling and performance for API and control planen/a

5.2 Forwarding performance

Scaling and performance for API and forwardingn/a

6. Upgrade 

Describe the upgrade impact of the feature. Schema migration/transitionn/a

7. Deprecations

If this feature deprecates any older feature or API then list it here.n/a

8. Dependencies

Describe dependent features or components.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