Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

Asciidoc Cleanup #170

Open
lesserwhirls opened this issue Sep 4, 2015 · 26 comments
Open

Asciidoc Cleanup #170

lesserwhirls opened this issue Sep 4, 2015 · 26 comments
Assignees

Comments

@lesserwhirls
Copy link
Collaborator

lesserwhirls commented Sep 4, 2015

Many warnings when converting asciidoc files to html regarding headings / sections out of sequence.

asciidoctor: WARNING: PointFeatures.adoc: line 24: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: CdmrCoverageParams.adoc: line 1: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: CdmrFeaturePoint.adoc: line 53: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: CdmrFeaturePoint.adoc: line 97: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: NcStreamGrammer.adoc: line 129: list item index: expected 3, got 1
asciidoctor: WARNING: NcStreamGrammer.adoc: line 130: list item index: expected 4, got 2
asciidoctor: WARNING: NcStreamGrammer.adoc: line 137: list item index: expected 4, got 1
asciidoctor: WARNING: NcStreamGrammer.adoc: line 138: list item index: expected 5, got 2
asciidoctor: WARNING: FeatureCollections.adoc: line 501: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 8: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 16: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 21: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 26: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 33: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 41: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 62: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 64: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 66: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 68: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 71: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 73: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 79: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 82: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 86: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 90: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 96: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 98: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 100: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 104: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: Grib.adoc: line 111: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: NetcdfSubsetServiceReference.adoc: line 142: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: NetcdfSubsetServiceReference.adoc: line 196: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: NetcdfSubsetServiceReference.adoc: line 216: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: NetcdfSubsetServiceReference.adoc: line 239: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: NetcdfSubsetServiceReference.adoc: line 246: section title out of sequence: expected level 2, got level 3

If you are the owner of one of these files

PointFeatures.adoc
CdmrCoverageParams.adoc
CdmrFeaturePoint.adoc
NcStreamGrammer.adoc
FeatureCollections.adoc
Grib.adoc
NetcdfSubsetServiceReference.adoc

please update with the correct sequence. For documentation on the correct sequence, please see http:https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#section-titles

@lesserwhirls lesserwhirls added this to the v5.0.0 milestone Sep 4, 2015
@JohnLCaron
Copy link
Collaborator

Not sure about this. Seems to expect "section headers" to always follow 1-2-3. But some are really just what size of title (h1, h2, h3) do you want. pandoc just copies over what is in the html.

so, can we set header size independent of the section numbering?

@dopplershift
Copy link
Member

Yeah, I'd argue that choosing the heading level based purely for font size is the precisely the wrong thing to do. Use the proper semantic meaning in the markup (html/asciidoc), then use the stylesheet (CSS) to control the appearance.

@JohnLCaron
Copy link
Collaborator

so, can we set header size independent of the section numbering?

@dopplershift
Copy link
Member

Well, you can easily set the font size of all <h1> tags, etc. If you're wanting to vary the size of individual <h3> tags, I'd say that's a bad idea.

@lesserwhirls
Copy link
Collaborator Author

Hi all,

I updated the css to use what asciidoctor produces in terms of html tags and changed UpgradingTo5.adoc to use it. Here is what the page looked like before using the asciidoc specific css:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5-old.html

and here is what it looks like using the asciidoc specific css file (tds_adoc.css):

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5.html

At some point I need to run this by @oxelson and @ddirks to get their input, as I am sure I've missed a few things in the new css file.

I can also make a pull request on 5.0 to move over the new css file as well as the adoc and html for the UpgradingTo5 page; currently, this lives on a branch under my account.

@cwardgar
Copy link
Contributor

I'm okay with the 2nd version (it fits the Unidata "theme"), but we're not
getting syntax highlighting on the code. That's a really cool feature we're
missing.

On Mon, Sep 21, 2015 at 10:59 AM, Sean Arms [email protected]
wrote:

Hi all,

I updated the css to use what asciidoctor produces in terms of html tags
and changed UpgradingTo5.adoc to use it. Here is what the page looked like
before using the asciidoc specific css:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5-old.html

and here is what it looks like using the asciidoc specific css file (
tds_adoc.css
https://github.com/lesserwhirls/thredds/blob/adoc5/docs/website/tds/tds_adoc.css
):

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5.html

At some point I need to run this by @oxelson https://github.com/oxelson
and @ddirks https://github.com/ddirks to get their input, as I am sure
I've missed a few things in the new css file.

I can also make a pull request on 5.0 to move over the new css file as
well as the adoc and html for the UpgradingTo5 page; currently, this lives
on a branch under my account
https://github.com/lesserwhirls/thredds/tree/adoc5


Reply to this email directly or view it on GitHub
#170 (comment).

@lesserwhirls
Copy link
Collaborator Author

Ok, check it out again. I've added syntax highlighting via pygments, but that means in order to build the docs, you will need both asciidoctor as well as pygments (both python and ruby libs). Note that pygments is only compatible with python 2.7 at the moment, but they are working on compatibility for version 3.

@cwardgar
Copy link
Contributor

Given those extra dependencies, I don't think that AsciiDoc-with-pygments can be built by JRuby. That's going to be a problem down the line when we're rendering the AsciiDoc from Gradle, as that all relies on JRuby.

Here is an example using :source-highlighter: coderay. Not as pretty, admittedly, but I was able to render using JRuby.

@lesserwhirls
Copy link
Collaborator Author

Thanks for the heads-up @cwardgar! I moved UpgradingTo5.adoc to use coderay. It's not too bad, actually. We could customize the color scheme if we wanted to do so, but any highlighting is better than no highlighting.

@lesserwhirls
Copy link
Collaborator Author

I've updated all of the asciidoc files on 5.0 under docs/website/tds to use the following:

:source-highlighter: coderay
:stylesheet: ../tds_adoc.css (using correct path for each file)
:linkcss:

@cwardgar
Copy link
Contributor

Results of my most-recent run:

[cwardgar@MacBook-Pro ~/dev/projects/thredds2/docs] (adocfixes *%=)
$ find . -type f -name "*.adoc" | xargs asciidoctor 
asciidoctor: ERROR: Time.adoc: line 7: only book doctypes can contain level 0 sections
asciidoctor: WARNING: Time.adoc: line 9: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: Time.adoc: line 11: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: Time.adoc: line 13: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: CdmAttributes.adoc: line 6: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: CdmAttributes.adoc: line 12: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: CdmAttributes.adoc: line 19: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: Opendap.adoc: line 32: section title out of sequence: expected level 1, got level 3
asciidoctor: WARNING: Opendap.adoc: line 47: section title out of sequence: expected level 1, got level 3
asciidoctor: WARNING: Opendap.adoc: line 81: section title out of sequence: expected level 1, got level 3
asciidoctor: WARNING: Opendap.adoc: line 105: section title out of sequence: expected level 1, got level 3
asciidoctor: WARNING: Opendap.adoc: line 125: section title out of sequence: expected level 1, got level 3
asciidoctor: ERROR: DataReading.adoc: line 8: only book doctypes can contain level 0 sections
asciidoctor: WARNING: DataReading.adoc: line 14: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: DataReading.adoc: line 64: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: DataReading.adoc: line 113: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: DataReading.adoc: line 152: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: DataReading.adoc: line 252: section title out of sequence: expected level 1, got level 2
asciidoctor: ERROR: GribNotes.adoc: line 8: only book doctypes can contain level 0 sections
asciidoctor: WARNING: GribNotes.adoc: line 10: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: GribNotes.adoc: line 13: list item index: expected 2, got 1
asciidoctor: WARNING: GribNotes.adoc: line 14: list item index: expected 3, got 2
asciidoctor: WARNING: GribNotes.adoc: line 15: list item index: expected 4, got 2
asciidoctor: WARNING: GribNotes.adoc: line 16: list item index: expected 5, got 1
asciidoctor: WARNING: GribNotes.adoc: line 18: list item index: expected 6, got 2
asciidoctor: WARNING: GribNotes.adoc: line 19: list item index: expected 7, got 3
asciidoctor: WARNING: GribNotes.adoc: line 20: list item index: expected 8, got 1
asciidoctor: WARNING: GribNotes.adoc: line 21: list item index: expected 9, got 4
asciidoctor: WARNING: GribNotes.adoc: line 23: list item index: expected 10, got 1
asciidoctor: WARNING: GribNotes.adoc: line 25: list item index: expected 11, got 5
asciidoctor: WARNING: GribNotes.adoc: line 27: list item index: expected 12, got 1
asciidoctor: WARNING: GribNotes.adoc: line 29: list item index: expected 13, got 2
asciidoctor: WARNING: GribNotes.adoc: line 30: list item index: expected 14, got 6
asciidoctor: WARNING: GribNotes.adoc: line 31: list item index: expected 15, got 1
asciidoctor: WARNING: GribNotes.adoc: line 34: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: GribNotes.adoc: line 49: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: GribNotes.adoc: line 55: list item index: expected 2, got 1
asciidoctor: WARNING: GribNotes.adoc: line 56: list item index: expected 3, got 2
asciidoctor: WARNING: GribNotes.adoc: line 57: list item index: expected 4, got 3
asciidoctor: WARNING: GribNotes.adoc: line 58: list item index: expected 5, got 4
asciidoctor: WARNING: GribNotes.adoc: line 59: list item index: expected 6, got 2
asciidoctor: WARNING: GribNotes.adoc: line 61: list item index: expected 7, got 1
asciidoctor: WARNING: GribNotes.adoc: line 62: list item index: expected 8, got 2
asciidoctor: WARNING: GribNotes.adoc: line 63: list item index: expected 9, got 3
asciidoctor: WARNING: GribNotes.adoc: line 64: list item index: expected 10, got 4
asciidoctor: WARNING: GribNotes.adoc: line 66: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: GribNotes.adoc: line 77: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: GribNotes.adoc: line 82: list item index: expected 3, got 1
asciidoctor: WARNING: GribNotes.adoc: line 84: list item index: expected 4, got 2
asciidoctor: WARNING: GribNotes.adoc: line 85: list item index: expected 5, got 3
asciidoctor: WARNING: GribNotes.adoc: line 86: list item index: expected 6, got 1
asciidoctor: WARNING: GribNotes.adoc: line 88: list item index: expected 7, got 2
asciidoctor: WARNING: GribNotes.adoc: line 89: list item index: expected 8, got 3
asciidoctor: WARNING: GribNotes.adoc: line 91: list item index: expected 9, got 4
asciidoctor: WARNING: GribNotes.adoc: line 92: list item index: expected 10, got 1
asciidoctor: WARNING: GribNotes.adoc: line 94: list item index: expected 11, got 2
asciidoctor: WARNING: GribNotes.adoc: line 95: list item index: expected 12, got 3
asciidoctor: WARNING: GribNotes.adoc: line 100: section title out of sequence: expected level 1, got level 2
asciidoctor: ERROR: transition4.adoc: line 8: only book doctypes can contain level 0 sections
asciidoctor: WARNING: transition4.adoc: line 44: section title out of sequence: expected level 1, got level 3
asciidoctor: WARNING: AnnotatedSchema4.adoc: line 889: section title out of sequence: expected level 2, got level 3
asciidoctor: ERROR: faq.adoc: line 8: only book doctypes can contain level 0 sections
asciidoctor: WARNING: faq.adoc: line 12: section title out of sequence: expected level 1, got level 2
asciidoctor: ERROR: Formica.adoc: line 8: only book doctypes can contain level 0 sections
asciidoctor: WARNING: LogicalView.adoc: line 8: section title out of sequence: expected level 1, got level 2
asciidoctor: ERROR: reference.adoc: line 8: only book doctypes can contain level 0 sections
asciidoctor: WARNING: reference.adoc: line 12: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: reference.adoc: line 26: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: reference.adoc: line 38: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: reference.adoc: line 49: section title out of sequence: expected level 1, got level 2
asciidoctor: ERROR: Auth.adoc: line 8: only book doctypes can contain level 0 sections
asciidoctor: FAILED: /Users/cwardgar/dev/projects/thredds2/docs/website/netcdf-java/reference/Caching.adoc: Failed to load AsciiDoc document - invalid byte sequence in UTF-8
  Use --trace for backtrace

Seems like a lot of boring formatting errors that cropped up during the HTML -> AsciiDoc mass-conversion. We should all start chipping at away at these, like we did the Coverity defects.

@lesserwhirls
Copy link
Collaborator Author

I'll take a look, and I'll work in knocking down the ERROR messages this evening. The warnings are a more work, but maybe I can get it done this week, 🍺 willing.

@JohnLCaron
Copy link
Collaborator

doesnt seem too bad. GribNotes is internal and can be ignored. ill fix it
up when i get a chance.

can we get this html out onto the web and replacing the current 5.0 docs,
which are currently very old?

On Mon, Jan 11, 2016 at 8:49 AM, Sean Arms [email protected] wrote:

I'll take a look, and I'll work in knocking down the ERROR messages this
evening. The warnings are a more work, but maybe I can get it done this
week, [image: 🍺] willing.


Reply to this email directly or view it on GitHub
#170 (comment).

@lesserwhirls
Copy link
Collaborator Author

Hi John,

I can start pushing the html files (converted from adoc) to the main
THREDDS documentation directory for 5.0 if there are no objections from
anyone else.

Cheers,

Sean

On Sun, Jan 17, 2016 at 11:06 AM, John Caron [email protected]
wrote:

doesnt seem too bad. GribNotes is internal and can be ignored. ill fix it
up when i get a chance.

can we get this html out onto the web and replacing the current 5.0 docs,
which are currently very old?

On Mon, Jan 11, 2016 at 8:49 AM, Sean Arms [email protected]
wrote:

I'll take a look, and I'll work in knocking down the ERROR messages this
evening. The warnings are a more work, but maybe I can get it done this
week, [image: 🍺] willing.


Reply to this email directly or view it on GitHub
#170 (comment).


Reply to this email directly or view it on GitHub
#170 (comment).

@JohnLCaron
Copy link
Collaborator

any improvements to css?

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5.html

looks pretty bad from my aesthetic POV.

On Mon, Sep 21, 2015 at 6:59 AM, Sean Arms [email protected] wrote:

Hi all,

I updated the css to use what asciidoctor produces in terms of html tags
and changed UpgradingTo5.adoc to use it. Here is what the page looked like
before using the asciidoc specific css:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5-old.html

and here is what it looks like using the asciidoc specific css file (
tds_adoc.css
https://github.com/lesserwhirls/thredds/blob/adoc5/docs/website/tds/tds_adoc.css
):

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5.html

At some point I need to run this by @oxelson https://github.com/oxelson
and @ddirks https://github.com/ddirks to get their input, as I am sure
I've missed a few things in the new css file.

I can also make a pull request on 5.0 to move over the new css file as
well as the adoc and html for the UpgradingTo5 page; currently, this lives
on a branch under my account
https://github.com/lesserwhirls/thredds/tree/adoc5


Reply to this email directly or view it on GitHub
#170 (comment).

@dopplershift
Copy link
Member

Can you be more specific? I clicked the link expecting an eyesore, but was pleasantly surprised. It's not perfect, but I'd be hard-pressed to actually say how I would make it better.

@JohnLCaron
Copy link
Collaborator

pretty much all the differences from

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5-old.html

except for the double header

On Fri, Jan 29, 2016 at 8:30 AM, Ryan May [email protected] wrote:

Can you be more specific? I clicked the link expecting an eyesore, but was
pleasantly surprised. It's not perfect, but I'd be hard-pressed to actually
say how I would make it better.


Reply to this email directly or view it on GitHub
#170 (comment).

@lesserwhirls
Copy link
Collaborator Author

Hi John, all:

I just moved over the 5.0 asciidoctor -> html docs to the top level
directory of the docs:

tds: http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/TDS.html
netcdf-java:
http:https://www.unidata.ucar.edu/software/thredds/v5.0/netcdf-java/documentation.html

The old, non-asciidoctor docs are backed-up here:

tds: http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/tds/TDS.html
netcdf-java:
http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/netcdf-java/documentation.htm

How does the asciidoctor -> html version look:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/tds/UpgradingTo5.html

compared to the old version:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/tds/UpgradingTo5-old.html

I know some of the links are not working correctly, but I have a PR on
github that fixes many, if not all, of them. Once the PR is accepted, then
the docs will auto build and update within 2 minutes.

Sean

On Fri, Jan 29, 2016 at 11:39 AM, John Caron [email protected]
wrote:

pretty much all the differences from

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5-old.html

except for the double header

On Fri, Jan 29, 2016 at 8:30 AM, Ryan May [email protected]
wrote:

Can you be more specific? I clicked the link expecting an eyesore, but
was
pleasantly surprised. It's not perfect, but I'd be hard-pressed to
actually
say how I would make it better.


Reply to this email directly or view it on GitHub
#170 (comment).


Reply to this email directly or view it on GitHub
#170 (comment).

@cwardgar
Copy link
Contributor

In my opinion, the version with AsciiDoctor's default CSS is the best-looking: http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/tds/UpgradingTo5-old.html. Unfortunately, it doesn't really fit the new Unidata theme.

The workshop-style CSS (http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/tds/UpgradingTo5.html) isn't too bad, but I really dislike the boxing of sections. The Unidata theme already forces us into a narrow column and that CSS needlessly wastes even more space, both horizontally and vertically.

@JohnLCaron
Copy link
Collaborator

am i the only one who dislikes?

the border around the sections, the lack of shading, the fonts and font
size. i like the old one much more.

for links, can you remind me what they should look like or point to a
canonical example?

thanks

On Fri, Jan 29, 2016 at 12:00 PM, Sean Arms [email protected]
wrote:

Hi John, all:

I just moved over the 5.0 asciidoctor -> html docs to the top level
directory of the docs:

tds: http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/TDS.html
netcdf-java:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/netcdf-java/documentation.html

The old, non-asciidoctor docs are backed-up here:

tds: http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/tds/TDS.html
netcdf-java:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/netcdf-java/documentation.htm

How does the asciidoctor -> html version look:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/tds/UpgradingTo5.html

compared to the old version:

http:https://www.unidata.ucar.edu/software/thredds/v5.0/bkup/tds/UpgradingTo5-old.html

I know some of the links are not working correctly, but I have a PR on
github that fixes many, if not all, of them. Once the PR is accepted, then
the docs will auto build and update within 2 minutes.

Sean

On Fri, Jan 29, 2016 at 11:39 AM, John Caron [email protected]
wrote:

pretty much all the differences from

http:https://www.unidata.ucar.edu/software/thredds/v5.0/tds/UpgradingTo5-old.html

except for the double header

On Fri, Jan 29, 2016 at 8:30 AM, Ryan May [email protected]
wrote:

Can you be more specific? I clicked the link expecting an eyesore, but
was
pleasantly surprised. It's not perfect, but I'd be hard-pressed to
actually
say how I would make it better.


Reply to this email directly or view it on GitHub
<#170 (comment)
.


Reply to this email directly or view it on GitHub
#170 (comment).


Reply to this email directly or view it on GitHub
#170 (comment).

@dopplershift
Copy link
Member

I like the "old" one better--but we're pretty hamstrung here by fitting within the master CSS for UCAR/Unidata. Do we have any options here? We could always move to github.io.....

@cwardgar
Copy link
Contributor

Or host it on S3. Any time we move one of our products or some aspect of our workflow off UCAR servers, I'm a happy guy.

@lesserwhirls
Copy link
Collaborator Author

Hi all,

I'm ok with either version, and certainly not stuck on one over the other.
github.io sounds nice (as soon as they upgrade their version of
asciidoctor), and S3 does not sound bad either. We should talk with Doug
tomorrow to get his opinion, but he generally seems open to exploration.

Sean

  • edited to remove inaccurate statement not pursuant to the issue at hand

On Sun, Jan 31, 2016 at 3:57 PM, Christian W [email protected]
wrote:

Or host it on S3. Any time we move one of our products or some aspect of
our workflow off UCAR servers, I'm a happy guy.


Reply to this email directly or view it on GitHub
#170 (comment).

@ddirks
Copy link

ddirks commented Feb 1, 2016

Hi all,

Sorry, I've not been watching this thread or would have chimed in sooner.

It's my hope that we can come up with a stylesheet that is broadly useful for all Unidata software documentation, looks good, and integrates itself tolerably with the Unidata web site styling. This doesn't mean it has to look the same as the more general pages, only that the designs should mesh reasonably well. (If you'll recall, we're working under something of a mandate that the web site use -- or at least not clash with -- a UCAR-wide design template.)

I'm cognizant that the "we" at the beginning of the last paragraph really means that I have to make more of an effort to create space in my schedule to actually do this, rather than just saying "we should do that" as I have been pretty much since Sean showed me the asciidoc stuff. My bad, but it just hasn't come to the top of the priority list. I'm still working on the NSF annual report, but that's easing off and with luck I can focus on writing a style sheet Real Soon Now.

Just so you know, Ward has approached me regarding the styling of the netCDF docs, so that's an additional prod to get me to prioritize this.

-=DD=-

@JohnLCaron
Copy link
Collaborator

Any progress?

@lesserwhirls
Copy link
Collaborator Author

Hi John,

This is going to be my focus as I recover from surgery over the next few
weeks.

Sean

On Saturday, July 30, 2016, John Caron [email protected] wrote:

Any progress?


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#170 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAEGGJBEzDj4JhYz7HJiKUn4pJ8uZ2wUks5qa9j4gaJpZM4F4F3P
.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Development

No branches or pull requests

5 participants