Raku / doc

🦋 Raku documentation
https://docs.raku.org/
Artistic License 2.0
286 stars 293 forks source link

Create page for environment variables the interpreter uses #949

Closed coke closed 6 years ago

coke commented 7 years ago

e.g. search for RAKUDO_NO_DEPRECATIONS

coke commented 7 years ago

FYI, bad example if we're removing RAKUDO specific env vars.

AlexDaniel commented 6 years ago

Errr… pretty sure that this page has to be deleted. All useful info from it should be moved to https://github.com/rakudo/rakudo/wiki/dev-env-vars (and other rakudo wiki pages)

JJ commented 6 years ago

That's two different things, removing the page and moving it to rakudo wiki or doc page. The second part will depend on what the devs there will want to do with them, right?

coke commented 6 years ago

One big happy family, we shouldn't remove it from here until it's listed there.

JJ commented 6 years ago

Big happy family with 2-year old issues that are already teething... I get your point, but still...

coke commented 6 years ago

Yes, I'm well aware of how old some of theses issues are, especially the ones I've opened. Patches and updates most welcome, thank you.

AlexDaniel commented 6 years ago

@JJ fwiw you should have access to edit rakudo wiki, and wikis are editable by all by definition. Devs are irrelevant in this case.

JJ commented 6 years ago

2018-02-09 19:27 GMT+01:00 Will Coleda notifications@github.com:

Yes, I'm well aware of how old some of theses issues are, especially the ones I've opened. Patches and updates most welcome, thank you.

One can do what one can do. I'd happily assist with this, and indeed I have tried to have a look at the POD and at the wiki, and I really have no idea where to start. I only want to help, and one thing that would do that is to focus on what the volunteers in this project can do and will do. There are enough issues such as it is now. Even low hanging fruits are difficult to tackle. As I said, I'm only trying to help, and I appreciate yours and every one else's work. But there's a pile of almost 300 issues, and cutting it down just a little tiny bit using the criterium of not kicking the ball down the line would really help. Words are words, and actions are actions. If it really depends on the other repository, my proposal would be to open an issue there with reference to this one and close this one. That way, if it really needs to be reopened we can do it; if anything happens there, there's a link. But taking this burden off our shoulders might help to focus on the rest of the burden: pages to create from scratch, build issues, many other things out there.

JJ commented 6 years ago

Of course I do. But wiki is markdown and POD6 is POD6. I would need a pod6 to markdown converter, and that would be just the start. I've really walked that path this morning, I'm not putting this out of spit or laziness. Then Rakudo is a different community. Their wiki, their rules. I don't have writing permission there. They can happily accept the stuff, or want it to move somewhere else or just, jeez, I don't know. I would have spent a while converting stuff and editing the wiki for nothing. If you don't want to erase the file, right, so be it. I have an issue with the issues themselves. Their problem, their issue. We've already agreed that it's not our place. I can happily do the issue and even do the conversion and insert it right there in the issue. Then they can do whatever they want or assign the issue in rakudo to me, and I'll happily assist.

AlexDaniel commented 6 years ago

@JJ wiki pages on github support different markup languages. POD5 is supported. Converting POD6 to POD5 shouldn't take enormous amounts of effort I assume (I'm speaking of doing it manually).

JJ commented 6 years ago

You realize that that's really the very first part of what I just said, right? I looked at the page mentioned above and it covers just environment variables. So that means I'll have to look for the proper place for it; and it might be erased after all, because wikis are wikis. Be that as it may, it might be easier to do all that than keep discussing this, and after all, we all want the same: a great and sane perl6. So I'll try that and come back here.

JJ commented 6 years ago

Well, that particular page is written in markdown: screenshot from 2018-02-09 19 54 22 And that one is only for environment variables. There's no page that covers the same area as the proposed file. I'll go and create one, and kinda dump everything there. Then let's see what's the reaction...

JJ commented 6 years ago

Well, took me a good while, basically the 24 minutes from my previous message, with one issue #1763 created in the process, but there it is https://github.com/rakudo/rakudo/wiki/Running-rakudo-from-the-command-line Can we proceed?

zoffixznet commented 6 years ago

I think this Issue a bit outlived itself. When it was created, only a couple of Rakudo-specific env vars were listed on it.

The latest version of the page, before it got removed, contained many more vars, including language env vars like PERL6_TEST_DIE_ON_FAIL, which should be in language docs, not in a wiki of some particular implementation. So at least those ones should be brought back.

As for the general moving of RAKUDO_ vars to the wiki, I'm not exactly sure how it helps our users to require them to go to some third-party resource and try to find the required information among pages like "MOLD Removal SQUASHathon" and "save me from texas".

AlexDaniel commented 6 years ago

find the required information among pages like "MOLD Removal SQUASHathon" and "save me from texas".

Heh. That's a good point.

JJ commented 6 years ago

Maybe we should change the issue title to "Create language environment variables page"? What the title said was precisely what was done, move it to the wiki.

AlexDaniel commented 6 years ago

@JJ please feel free to edit titles in general, and also any of my comments if you feel necessary.

JJ commented 6 years ago

@AlexDaniel if what we want is to have a new page, I think it's much better to open a new issue saying just that. @zoffixznet , what do you think? Let what's been closed stay closed :-)

AlexDaniel commented 6 years ago

@JJ Yes, that's the right way to do it I think. FWIW that's even written as a recommendation for squashathons:

If the ticket is asking for more than one thing, replace with new smaller tickets and close it. If you see a lot of out-of-place discussion, try to understand the main point and create a new highly-specific ticket to replace it.

So creating a new ticket usually makes things go easier, but having a link to the previous ticket never hurts I think.

JJ commented 6 years ago

... and the wiki :-) (I'll close this when I -- or someone else -- creates the ticket(s))

ghost commented 6 years ago

Wouldn't it make more sense to just update the original file this all seems to be copy-pasted from, https://github.com/rakudo/rakudo/blob/master/docs/running.pod? I even mentioned it was perfectly good material going to waste in perl6/user-experience#9, but got no response.

JJ commented 6 years ago

Do you mean update it right there in the rakudo repo?

ghost commented 6 years ago

It would be useful to keep that file up to date, since every rakudo release tarball already contains it.