eXist-db / documentation

Documentation of eXist
13 stars 44 forks source link

Migrate any documentation from atomic wiki into the core documentation #102

Open joewiz opened 7 years ago

joewiz commented 7 years ago

From @dizzzz on eXist-open, referring to http://atomic.exist-db.org/HowTo/JettySSL:

that document is from 2008 ! it is probably outdated :-/ (classic issue with wikis)

joewiz commented 7 years ago

Does anyone have a list of the available atomic wiki articles that we could consider as candidates for inclusion in the documentation? (Unfortunately the list of articles in the "HowTo" section does not link to the articles.) :(

duncdrum commented 6 years ago

@joewiz is this still an issue?

joewiz commented 6 years ago

@duncdrum Yes, why do you ask? I was proposing that we consider articles such as http://atomic.exist-db.org/HowTo/JettySSL as candidates for inclusion in the eXist core documentation. Has that been folded in?

Or did you mean the atomicwiki link issue I mentioned in my 2nd post? I'm still unable to load the list of all "HowTo" articles. Loading http://atomic.exist-db.org/HowTo returns a message, "Either the feed is empty or you are not allowed to view the entries".

dizzzz commented 6 years ago

That SSL article is not relevant anymore as exist 3+ has the HTTPS port open by default,,,, mentioning that is it on port 8443 should be sufficient?

duncdrum commented 6 years ago

Ok then, here is a list of documentation candidates from the wiki (tick means that information in docs covers or supersedes the wiki article):

@eriksiegel this might be of interest to you as well

duncdrum commented 6 years ago

@adamretter SQL, and the triplet of captcha akisnet, asirra articles are from you any thoughts if they should go into the docs?

@joewiz a number of articles have been moved some time ago, but I can find no trace of the decision process, so its possible that the ones that weren't, didn't make it into the docs for a reason.

@dizzzz some of this stuff seems to be your kind of thing (eclipse, tipsntricks?) any idea if and what should get moved

@JoernT FormValidation talks about ModelValidatorin the context of betterform, xform, etc is this still relevant? see eXist-db/exist#560

The only immediate candidate to me is the article on configuring TravisCI.

xatapult commented 6 years ago

@duncdrum I'll await the results of this discussion. When i have time left after doing what is now the core documentation I could pick up some of the articles for editing and inclusion.

duncdrum commented 6 years ago

Update for better legibility: @adamretter your wiki articles that need a vote:

@dizzzz:

@JoernT:

other:

duncdrum commented 6 years ago

see eXist-db/exist#1778

adamretter commented 6 years ago

@duncdrum these should stay on the Wiki as they are more example code:

  1. AkismetAPI
  2. AsirraAPi
  3. Captcha

Where can I find the Puppet and SQL Databases articles to check?

duncdrum commented 6 years ago

@adamretter https://exist-db.org/exist/apps/wiki/HowTo/SQLDatabases/

duncdrum commented 6 years ago

Outstanding wiki articles: 5/33

joewiz commented 5 years ago

@duncdrum By "outstanding" (in https://github.com/eXist-db/documentation/issues/102#issuecomment-389493850), these are the 5 remaining wiki articles that need to be adapted to the documentation, correct?

duncdrum commented 5 years ago

Yup

line-o commented 3 years ago

The connection to SQLDatabases was recently updated to allow pooling. Documenting that would be a great opportunity to get one step closer to closing this issue.

adamretter commented 3 years ago

Documenting that would be

@line-o Already documented - https://github.com/eXist-db/documentation/pull/608

line-o commented 3 years ago

Now that you said it :) I remember reviewing that. So ... is this issue still valid?