User talk:SHELTIM: Difference between revisions

From Elanthipedia
Jump to navigation Jump to search
(→‎Lich scripts: new section)
 
 
(8 intermediate revisions by 3 users not shown)
Line 10: Line 10:


Cheers - [[User:RY4NPW|padhg]] ([[User talk:RY4NPW|talk]]) 10:28, 14 June 2016 (CDT)
Cheers - [[User:RY4NPW|padhg]] ([[User talk:RY4NPW|talk]]) 10:28, 14 June 2016 (CDT)

: There is no need to put script source on elanthipedia as all source is available via GitHub (https://github.com/rpherbig/dr-scripts) or the built-in Lich ;repository functionality. As well, some scripts are very large (2KLOC+) and they change often.

: My goal here is not to reproduce the scripts in their entirety, but only to document the configuration (settings) of those scripts. I found GitHub's wiki functionality to be rather limiting and I was hoping to document such things here instead.

: My co-developer [[User:Seped]] had a conversation with [[User:ABSOLON]] on this, I'm hoping one of them can chime in. [[User:SHELTIM|SHELTIM]] ([[User talk:SHELTIM|talk]]) 10:34, 14 June 2016 (CDT)

::If your goal is to maintain the scripts externally and you are worried about frequent updates, why not keep the configuration documentation on your README on the github page? By adding a "See also" link to your github repository on the [[:Category:Lich scripts]] page you will give it exposure so that people can find it. And you can maintain things conveniently outside of elanthipedia. - [[User:RY4NPW|padhg]] ([[User talk:RY4NPW|talk]]) 10:49, 14 June 2016 (CDT)

:::The [[:Category:Lich scripts]] page is the correct page for everything on [[Lich dr-scripts]] to be under. This is as was discussed with Seped via aim, during which conversation I created the category pages necessary.
:::The content of [[Dr-scripts/Script_List]] should be moved as well, since the page is a subpage of [[Dr-scripts]] which doesn't even have any content or any other subpages. Since there is very little content needed for each repository script, then you could probably just move the content of the dr-scripts/lich scripts page to the category page as is underneath the stuff from the lich dr-scripts page, rather than create an individual page for each script. Alternately, and probably a better solution, you could move contents of the dr-scripts/lich scripts page to [[Lich script repository]] (note- not a subpage of anything with a more informative title) and add it to the lich script category by including <nowiki>{{cat|Lich scripts}}</nowiki> on the page somewhere.--[[User:ABSOLON|ABSOLON]] ([[User talk:ABSOLON|talk]]) 12:29, 14 June 2016 (CDT)

:::: I moved the basic lich info to the [[:Category:Lich scripts]] page. I think there will be more information that belongs there, so I moved the script list to a separate page, [[Lich script list]]. I'd like to start fleshing out each scripts' information there, and we can consider moving to individual pages if it gets too long. [[User:SHELTIM|SHELTIM]] ([[User talk:SHELTIM|talk]]) 14:05, 14 June 2016 (CDT)

:::::I'm going to move [[Lich script list]] to [[Lich script repository]] per [[User:ABSOLON|ABSOLON]]'s comment. The main reason being that there could be scripts outside of your repository that could also be "listed" on the category page. This is to follow the precedent already in place from the [[:Category:Genie scripts]] page where there are multiple "repositories" maintained by external users on top of individual scripts added to elanthipedia on their own page.

:::::As a user, if I'm looking for Lich scripts, I could go to the category first to learn about them. Then would be directed to the repository page to read about configuration of scripts within that repository. - [[User:RY4NPW|padhg]] ([[User talk:RY4NPW|talk]]) 14:43, 14 June 2016 (CDT)

Latest revision as of 13:43, 14 June 2016

Lich scripts

Hi there, I saw you created two pages for scripts you've created for Lich. There is already a listing of known Lich scripts on the Category:Lich scripts page, which you should be able to edit and add your stuff to.

Typically, scripts have their own page and include some instructions as well as the source. This is because oftentimes external sites/links go down or are removed, and this allows those scripts to still be available. A few options for you to consider may be:

  • Following the existing script precedent create a page for each script, including documentation on usage including source code.
  • Alternatively, add a "See also" link to your script repository on the category page and include the necessary documentation on your repository's README.md. To do this, add this to the bottom of the Category page: {{RefAl|p=-|a=y}} *[[github page]]

Feel free to reach out to me using the contact information on my user page or leave a note on my Talk page with any questions or if you'd like some help.

Cheers - padhg (talk) 10:28, 14 June 2016 (CDT)

There is no need to put script source on elanthipedia as all source is available via GitHub (https://github.com/rpherbig/dr-scripts) or the built-in Lich ;repository functionality. As well, some scripts are very large (2KLOC+) and they change often.
My goal here is not to reproduce the scripts in their entirety, but only to document the configuration (settings) of those scripts. I found GitHub's wiki functionality to be rather limiting and I was hoping to document such things here instead.
My co-developer User:Seped had a conversation with User:ABSOLON on this, I'm hoping one of them can chime in. SHELTIM (talk) 10:34, 14 June 2016 (CDT)
If your goal is to maintain the scripts externally and you are worried about frequent updates, why not keep the configuration documentation on your README on the github page? By adding a "See also" link to your github repository on the Category:Lich scripts page you will give it exposure so that people can find it. And you can maintain things conveniently outside of elanthipedia. - padhg (talk) 10:49, 14 June 2016 (CDT)
The Category:Lich scripts page is the correct page for everything on Lich dr-scripts to be under. This is as was discussed with Seped via aim, during which conversation I created the category pages necessary.
The content of Dr-scripts/Script_List should be moved as well, since the page is a subpage of Dr-scripts which doesn't even have any content or any other subpages. Since there is very little content needed for each repository script, then you could probably just move the content of the dr-scripts/lich scripts page to the category page as is underneath the stuff from the lich dr-scripts page, rather than create an individual page for each script. Alternately, and probably a better solution, you could move contents of the dr-scripts/lich scripts page to Lich script repository (note- not a subpage of anything with a more informative title) and add it to the lich script category by including {{cat|Lich scripts}} on the page somewhere.--ABSOLON (talk) 12:29, 14 June 2016 (CDT)
I moved the basic lich info to the Category:Lich scripts page. I think there will be more information that belongs there, so I moved the script list to a separate page, Lich script list. I'd like to start fleshing out each scripts' information there, and we can consider moving to individual pages if it gets too long. SHELTIM (talk) 14:05, 14 June 2016 (CDT)
I'm going to move Lich script list to Lich script repository per ABSOLON's comment. The main reason being that there could be scripts outside of your repository that could also be "listed" on the category page. This is to follow the precedent already in place from the Category:Genie scripts page where there are multiple "repositories" maintained by external users on top of individual scripts added to elanthipedia on their own page.
As a user, if I'm looking for Lich scripts, I could go to the category first to learn about them. Then would be directed to the repository page to read about configuration of scripts within that repository. - padhg (talk) 14:43, 14 June 2016 (CDT)