-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathMIGRATION.txt
47 lines (31 loc) · 1.7 KB
/
MIGRATION.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
.. CGNS Documentation files
See LICENSING/COPYRIGHT at root dir of this documentation sources
-----------------------------------------------------------------------------
The migration is supposed to be a straightforward translation from a doc
format to another. This is not exactly the case, the first reason is that some
parts have be written for paper docs, with duplicated parts. The second is
the use of the reference links which implies some doc hierarchy reorganisation.
The existing pages of the original reference web site are sometimes
kept unchanged, sometime reorganized. No information is deleted, some
were duplicated.
The syntax for the following change log is:
(OLD-PAGE#SECTION, ...) -> (NEW-PAGE#SECTION, ...)
- CHANGES
please look carefully at the ??? marks. These are indicating some parts
of the pages that look weird, obsolete, redundant. These have been included
in this migration to make sure no information is missed by the migration
before any re-writing.
ReStructuredText reference:
https://docutils.sourceforge.io/rst.html
ReStructuredText Quick ref:
https://docutils.sourceforge.io/docs/user/rst/quickref.html
-----------------------------------------------------------------------------
(index.html) -> (index.rst)
- all links are kept in the table, even if some wuck links are also
now in the side bar
(WhatIsCGNS.html) -> (general/what.rst)
- add 'how can you help CGNS?'
(CGNS_docs_current/aiaa.html) -> (standard/reference.rst)
(CGNS_docs_current/overview/history.html) -> (general/history.rst)
(CGNS_doc_current/overview.html) -> (general/overview.rst)
- ??? do we still need to provide a tar.gz file of the (not maintained) pdf?