dev.clojure.org/display/doc/1.3 is ugly; I'd like to fix it

[Ben Smith-Mannschott]

Hi Clojure Devs!

http://dev.clojure.org/display/doc/1.3

Seems to have a number of markup issues:

- *earmuffs* become bold
- clearly [ ] must mean something special, 'cause they all turn pink.
- presumably there's some way to make confluence use monospace for
code snippets.
- I'm sure confluence has some way to mark headings, but It doesn't
look like "==" is it.
- I'd like to evict the "frowning face" from CLJ-751's clj-format example.
- 2.29 seems to have suffered some encoding debacle, though I'm not
quite sure what happened.

I'm operating on the hypothesis that these issues are not deliberate,
but that the core team has more pressing concerns than fighting around
with fiddly wiki markup issues for a few hours. I'd like to try my
hand at fixing these issues to make this page less ugly.

(We've sent people here to answer the question "what's new in 1.3".
It'd be nice if it made a decent impression.)

I've signed the CA and have an account on dev.clojure.org
(bsmit...@gmail.com), but no editing rights there.

How shall I proceed?

// Ben

[Alex Miller]

The text itself seems to be Markdown formatting. A quick search shows
a few Markdown Confluence plugins or translators. Maybe that would be
a quick solution.

> --
> You received this message because you are subscribed to the Google Groups "Clojure Dev" group.
> To post to this group, send email to cloju...@googlegroups.com.
> To unsubscribe from this group, send email to clojure-dev...@googlegroups.com.
> For more options, visit this group at http://groups.google.com/group/clojure-dev?hl=en.
>
>

[Chas Emerick]

It looks like that's just a copy/paste of https://github.com/clojure/clojure/blob/master/changes.txt.

Just a thought: If changes.txt were renamed to changes.md, then github would display it as intended — and people could be pointed to it instead of the dev wiki (which presumably will always lag whatever is in git?).

- Chas

[Ben Smith-Mannschott]

On Tue, Sep 6, 2011 at 16:30, Chas Emerick <ceme...@snowtide.com> wrote:
> It looks like that's just a copy/paste of https://github.com/clojure/clojure/blob/master/changes.txt.
>
> Just a thought: If changes.txt were renamed to changes.md, then github would display it as intended — and people could be pointed to it instead of the dev wiki (which presumably will always lag whatever is in git?).

That makes sense, except that It's not Markdown. If it were Markdown,
headings would be marked thus:

# Top Level
## Subheading

And code blocks would be indented by four spaces or one tab instead of
2 spaces. The headings make it look like it could be MediaWiki or some
related dialect. I'm not familiar enough with the wild and wooly world
of wiki markups to really know.

Since Stuart Halloway does has the most commits to changes.txt, He'd
presumably be the one to ask, but do you think A patch to convert
changes.txt to proper markdown would be of use?

In the meantime, I'll give it a shot on a local copy of the repo. My
new keyboard needs some exercise. :P

// Ben

[Ben Smith-Mannschott]

On Tue, Sep 6, 2011 at 17:21, Ben Smith-Mannschott
<bsmit...@gmail.com> wrote:
...

> In the meantime, I'll give it a shot on a local copy of the repo. My
> new keyboard needs some exercise. :P
>

I've hacked up a conversion here for interested parties to look at.

https://github.com/bpsm/clojure/blob/changes.md/changes.md

The contents should be identical to those of changes.txt, just the
markup has changed.

// Ben

[Christopher Redinger]

The original page at http://dev.clojure.org/display/doc/1.3 was only intended to be a working copy while we were in progress. I'm not sure this page provides any value going forward, and I'd like to change it to link to the official changelog in github.

Your conversion looks like a good idea though, can you make a patch in JIRA for that?

[Ben Smith-Mannschott]

Yes, I'd be happy to create an issue and attach a patch against the
current version of changes.txt, but I can't currently since, I don't
have permissions to create issues on http://dev.clojure.org/jira/.

I do have an account on dev.clojure.org (confluence), but no editing
rights. (bsmith.occs @ gmail.com) My C.A. is on file with Rich.

// Ben

> --
> You received this message because you are subscribed to the Google Groups
> "Clojure Dev" group.

> To view this discussion on the web visit
> https://groups.google.com/d/msg/clojure-dev/-/IGPfgEWe3yAJ.

[Christopher Redinger]

On Tue, Sep 13, 2011 at 9:34 AM, Ben Smith-Mannschott <bsmit...@gmail.com> wrote:

Yes, I'd be happy to create an issue and attach a patch against the
current version of changes.txt, but I can't currently since, I don't
have permissions to create issues on http://dev.clojure.org/jira/.

If you create an account at http://dev.clojure.org/jira I can give you access to create tickets.

 

I do have an account on dev.clojure.org (confluence), but no editing
rights. (bsmith.occs @ gmail.com) My C.A. is on file with Rich.

I've given you edit rights.

[Ben Smith-Mannschott]

On Wed, Sep 14, 2011 at 17:38, Christopher Redinger <redi...@gmail.com> wrote:
> On Tue, Sep 13, 2011 at 9:34 AM, Ben Smith-Mannschott
> <bsmit...@gmail.com> wrote:
>>
>> Yes, I'd be happy to create an issue and attach a patch against the
>> current version of changes.txt, but I can't currently since, I don't
>> have permissions to create issues on http://dev.clojure.org/jira/.
>
> If you create an account at http://dev.clojure.org/jira I can give you
> access to create tickets.

Thanks. I've created an account on Jira now. I didn't know that the
Jira instance didn't use the same accounts as the Confluence instance
on the same server.

>>
>> I do have an account on dev.clojure.org (confluence), but no editing
>> rights. (bsmith.occs @ gmail.com) My C.A. is on file with Rich.
>
> I've given you edit rights.

Thanks.

[Stuart Halloway]

If you create an account at http://dev.clojure.org/jira I can give you

access to create tickets.

Thanks. I've created an account on Jira now. I didn't know that the
Jira instance didn't use the same accounts as the Confluence instance
on the same server.

In theory the accounts propagate to both places via Crowd. In practice it seems to work less and less often. Sorry. :-(

Stuart Halloway
Clojure/core
http://clojure.com

[Christopher Redinger]

On Wed, Sep 14, 2011 at 11:56 AM, Ben Smith-Mannschott <bsmit...@gmail.com> wrote:

Thanks. I've created an account on Jira now. I didn't know that the

Jira instance didn't use the same accounts as the Confluence instance
on the same server.

And access granted.

 On Wed, Sep 14, 2011 at 11:58 AM, Stuart Halloway <stuart....@gmail.com> wrote:

In theory the accounts propagate to both places via Crowd. In practice it seems to work less and less often. Sorry. :-(

Confluence wizards apply within.

[Michael T. Nygard]

On Sep 14, 2011, at 11:05 AM, Christopher Redinger wrote:

 On Wed, Sep 14, 2011 at 11:58 AM, Stuart Halloway <stuart....@gmail.com> wrote:

In theory the accounts propagate to both places via Crowd. In practice it seems to work less and less often. Sorry. :-(

Confluence wizards apply within.

I've dealt with Crowd/Confluence/Jira integration before.

Michael T. Nygard | @mtnygard | Relevance, Inc. | 952-428-8794

[Ben Smith-Mannschott]

On Wednesday, September 14, 2011, Christopher Redinger wrote:

On Wed, Sep 14, 2011 at 11:56 AM, Ben Smith-Mannschott <bsmit...@gmail.com> wrote:

Thanks. I've created an account on Jira now. I didn't know that the

Jira instance didn't use the same accounts as the Confluence instance
on the same server.

And access granted.

Thank you! I've created an issue and attached patches here:

http://dev.clojure.org/jira/browse/CLJ-838

I've also commented on the issue with two questions:

- is the TOC necessary?

- is the section numbering necessary?

Other than maintenance burden, what do they add?

// Ben

 

 On Wed, Sep 14, 2011 at 11:58 AM, Stuart Halloway <stuart....@gmail.com> wrote:

In theory the accounts propagate to both places via Crowd. In practice it seems to work less and less often. Sorry. :-(

Confluence wizards apply within.

--