Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
  • Jul 05 19:38
    greggirwin opened #264
  • Feb 25 17:24
    temperfugit edited #263
  • Feb 25 17:23
    temperfugit opened #263
  • Feb 25 17:05
    greggirwin commented #262
  • Feb 25 17:05

    greggirwin on master

    FIX: malformed MAP! literals. Merge pull request #262 from 92… (compare)

  • Feb 25 17:05
    greggirwin closed #262
  • Feb 25 14:48
    9214 opened #262
  • Jan 16 14:08
    Tovim synchronize #252
  • Jan 14 01:40
    greggirwin commented #261
  • Jan 12 09:17
    meijeru opened #261
  • Jan 09 21:34

    greggirwin on master

    Created initial natives.adoc Merge pull request #259 from gl… (compare)

  • Jan 09 21:34
    greggirwin closed #259
  • Jan 09 21:34
    greggirwin commented #259
  • Jan 09 21:28
    greggirwin edited #260
  • Jan 09 21:27
    greggirwin opened #260
  • Jan 08 21:27
    gltewalt opened #259
  • Jan 08 18:27

    greggirwin on master

    Created initial actions.adoc Merge pull request #258 from gl… (compare)

  • Jan 08 18:27
    greggirwin closed #258
  • Jan 08 03:52
    gltewalt opened #258
  • Dec 30 2020 19:38

    greggirwin on master

    Pull content from blog Source … (compare)

gltewalt (The other Greg)
@gltewalt:matrix.org
[m]
Html
Greg T
@gltewalt
offset a bit with a border?
https://imgur.com/y1v5svS
Greg T
@gltewalt
Greg T
@gltewalt

What is this? Is it something from the team?

https://red-language-documentation.readthedocs.io/en/latest/

Gregg Irwin
@greggirwin
Interesting. I hadn't seen it. Looks experimental, and from almost 5 years ago. Doc is listed as the maintainer, but it's not in my head. It's a nice rendering, but I don't know what readthedocs maintenance involves. If you want to find out, post your thoughts here, that would be great. @x8x also has a really nice docs layout (https://w.red-lang.org/), but I think that requires manual upkeep as well.
Greg T
@gltewalt
Ok, I will look into it tonight
Gregg Irwin
@greggirwin
Thanks!
Greg T
@gltewalt

readthedocs.io

You can connect a readthedocs account to a github account, then can click import on a repostiory.
Once imported it builds out the docs.
Then you have to manually configure a webhook so that docs are updated with new changes.
So, doesn't seem like much maintanance is required, or much manual work after everything is set up.
Workload is mostly up front.

There are business accounts that probably give you more, but I didn't look at that.

I don't know the reasons for starting an account there and then abandoning it - possibly because at the time I believe the docs were in markdown?

Pros:
Free doc hosting.
Webhooks - when code is pushed with Git, docs are built. Stays in sync.
Multiple docs versions - branch or tag with git.
Can build multiple formats: pdf, ePub, html

Cons:
Relying on (or tied to) Python.
reStructuredText is the prefered markup (Part of Pythons javadoc-like attempt). No Asciidoc.
Can use markdown but it is limited.

Greg T
@gltewalt
Setting up a webhook on github and then using @x8x stuff (or other web dev) is an option.
Gregg Irwin
@greggirwin

Thanks @gltewalt. Great info. Now that we're using AD, it will be more work to support it, from what you say. However, if people think there's value in having reflective help there, your recent work could emit MD.

How tightly are things tied to Python, or what parts are that would affect us and integrating with it?

gltewalt (The other Greg)
@gltewalt:matrix.org
[m]
Fairly tightly knit with python - have to use python locally, install sphinx and recommonmark through the package manager, and edit a .py config file. I'm not sure that the Red team wants to lean on python tooling, though there is a balance somewhere between being reliant on other things, and doing everything in house.
A local docs directory would be the sphinx project scaffolding
Gregg Irwin
@greggirwin
That's a bummer. Yeah, we may not want to do all that.
@x8x do we have any other Python dependencies in our webhook chain for other stuff at this point?
gltewalt (The other Greg)
@gltewalt:matrix.org
[m]

There is also asciidoctor which spits out htm from asciidoc by default.

https://asciidoctor.org

Looks good to the viewer, pretty noisy when viewing source
FLuX LoOP
@x8x
We don't use Python for anything that I can think of.
Gregg Irwin
@greggirwin
Thanks @x8x. So we probably won't pursue that @gltewalt:matrix.org. If there's someone in the community that wants to host that process, knows Python, and all we need to do is provide content in a given format for them to pull, we could look at that.
Filip Oščádal
@mxdpeep

There is also asciidoctor which spits out htm from asciidoc by default.

https://asciidoctor.org

I use it daily from a docker container, works

Greg T
@gltewalt
I think asciidoctor is the best bet for right now - if you want html version of the asciidoc docs.

Their site is composed in asciidoc. The html that you see if from asciidoctor, with their own css style.

https://asciidoctor.org/

Bonus - the headers are colored red
FLuX LoOP
@x8x
@gltewalt we use asciidoctor since always.. and we also do SPA and PWA if that's the new buzz words.. :smiley:
Greg T
@gltewalt
'We' as in?
FLuX LoOP
@x8x

https://docs.github.com/en/github-ae@latest/developers/webhooks-and-events/webhooks

Thanks! That looks like an interesting option! :thumbsup:

Greg T
@gltewalt
This could use some volunteers. Last touched in January.
https://github.com/red/red/wiki/%5BHOWTO%5D-How-Do-I-Do-X-with-Red%3F
The common How-Tos could be factored out and used as a kind of parent class to the "How Do I", and the "Coming to Red from another language" writings
Cross referenced, at least
Gregg Irwin
@greggirwin
:+1:
mikeparr
@mikeparr
@gltewalt I wonder if this 'CommonTasks In Series' material is any use? https://www.red-by-example.org/series.html#15
Greg T
@gltewalt
Yes, good information. Should probably link to those from "How Do I"
rseger
@rseger
I added a suggested "potential gotchas" section to https://github.com/red/red/wiki/Coming-to-Red-from-Python. And added a note about namespaces (hopefully a helpful one) - feel free to tweak/remove as desired :)
Gregg Irwin
@greggirwin

Good stuff @rseger , thanks!

Another thing you might hear is that "words carry their context with them".

rseger
@rseger
my pleasure :)
Greg T
@gltewalt
the "zipped" Direct links to latest builds links are dead on the download page