FLUID-6062: Assess whether we should apply a particular docs style and workflow for features which are new in a particular Infusion release

Metadata

Source
FLUID-6062
Type
Task
Priority
Major
Status
Closed
Resolution
Migrated
Assignee
Jonathan Hung
Reporter
Antranig Basman
Created
2016-11-11T12:14:06.991-0500
Updated
2022-03-14T13:29:48.078-0400
Versions
N/A
Fixed Versions
  1. 5.0
Component
  1. Docs platform
  2. Tech. Documentation

Description

As part of the review for pull https://github.com/fluid-project/infusion-docs/pull/103 documenting some features which are new for the Infusion 2.0 release, @jobara suggested that we might want to adopt a particular styling for features which are new in a particular framework release, together with a workflow for removing this styling once the subsequent release has appeared.

In general we need to start versioning our docs properly as well (this was always the plan, given our URL structure, but has never been implemented) so that docs for each historical release can be accessed cleanly, as with, for example, historical versions of the node.js API at links like https://nodejs.org/docs/v4.6.2/api/

We should take up the styling issues with the design team, and work on the improvements to our scripts together with the work required on our docs platform at https://issues.fluidproject.org/browse/FLUID-5823

Comments

  • Dana commented 2016-11-17T14:04:13.519-0500

    As we discussed at the crit – something like this @@Justin Obara, @@Simon Bates, @@Jonathan Hung, @@Antranig Basman (see attachment)? I added some highlighting to the text as it sounded like part of the problem is that it's too easy to miss the changes. I don't think the text alone would solve that.

  • Justin Obara commented 2016-12-06T13:35:55.112-0500

    Quick example of the styles in the "Styling flag for FLUID-6062.pdf" https://jsfiddle.net/wgknohuj/3/

  • Justin Obara commented 2016-12-12T15:47:21.317-0500

    We discussed this at the Floe Planning meeting today. The decision is that we will start adding the "new/changed in" flags after the Infusion 2.0 release.

  • Justin Obara commented 2022-03-14T13:22:40.360-0400

    Migrated to Infusion Docs Issue #224