Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

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

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

Environment

None

Attachments

1

Activity

Show:

Justin Obara March 14, 2022 at 5:22 PM
Edited

Migrated to Infusion Docs Issue #224

Justin Obara December 12, 2016 at 8:47 PM

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 December 6, 2016 at 6:35 PM
Edited

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

Dana November 17, 2016 at 7:04 PM

As we discussed at the crit – something like this , , , (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.

Migrated

Details

Assignee

Reporter

Components

Fix versions

Priority

Created November 11, 2016 at 5:14 PM
Updated March 14, 2022 at 5:29 PM
Resolved March 14, 2022 at 5:22 PM