Date: Fri, 29 May 2020 17:48:52 +0000 (UTC) Message-ID: <417918631.10141.1590774532055@aws-us-west-2-tungsten-confluence-1.web.codeaurora.org> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_10140_1727089271.1590774532055" ------=_Part_10140_1727089271.1590774532055 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html Docs De-Contrailization Style Guide

Docs De-Contrailization Style Guide

We're working to trans= ition the Contrail 5.0.x documentation to Tungsten Fabric. This essenti= ally means manually reviewing each file and transitioning only the right th= ings from 'Contrail' to 'Tungsten Fabric'.

As we work on this project, team members will use this wiki page to shar= e their best practices for the transitions.

Due to the existence of the `contrail` term in the name= of the services which are launched, we will not be removing this terminolo= gy until the actual code/services are updated with a name change.  Bec= ause of this, we will not be renaming these occurrences or the associated w= ording when referencing the service.  The first pass, prior to the ser= vices being renamed, will result in both `Tungsten Fabric`= and `Contrail` terminology being present in the document.=


Section = Header Separators

In some cases the word Contrail will be in a section header. These heade= rs are marked by lines composed of `-` or `=3D` characters. These lines sho= uld be as long as the header text that they mark. Changing the header from = `Contrail` to `Tungsten Fabric` increases the length of the header text, so= the line length should increase accordingly. For example, this header:

=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Support for IPv6 Networks in = Contrail
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D

Will become:
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Support = for IPv6 Networks in Tungsten Fabric
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D

This is incorrect:

=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
Support for IPv6 Networks in = Tungsten Fabric
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D

Handling Release/Version references

Once in a while there are references to specific versions of the softwar= e. For example:

Starting with Contrail Release 2.0, support for IPv6 overlay networks =
is provided.

In situations like this, rather than replacing `Contrail` with `Tungsten= Fabric`, simply remove the word `Contrail`. The line above would become:

Starting with Release 2.0, support for IPv6 overlay networks is provid=
ed.

The exception to this rule is for Release v5.x references. Because Tungs= ten Fabric came into being around v5.0, replace those instances of `Contrai= l` to `Tungsten Fabric`.



------=_Part_10140_1727089271.1590774532055--
https://wiki.tungsten.io/exportword?pageId=10060238
wiki.tungsten.io
crawl=CC-MAIN-2020-24
9628
application/http; msgtype=response
sha1:EWMLE7NP5723ORWQEFV2ZZB2QUVLBD76
<urn:uuid:a642962b-ca14-48e8-ac44-9c257c93155c>
2020-05-29T17:48:52Z
52.38.170.137
message/rfc822
sha1:7U3OKQWW5JWBZLUAZKPDKFU4POJVGB7O
<urn:uuid:f14bac09-938d-477f-8b2d-f850d0c646f6>
https://wiki.tungsten.io/exportword?pageId=10060238
response
<urn:uuid:f7996627-1f75-458c-81f0-4f1944ac61d0>
isPartOf: CC-MAIN-2020-24
publisher: Common Crawl
description: Wide crawl of the web for May/June 2020
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-117.ec2.internal
software: Apache Nutch 1.16 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.1-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/