What is a version of on-line ELGG reference?
Hello.
Does this reference
http://reference.elgg.org/master/index.html
belong to 1.9? ...
... or to 1.8?
Or perhaps this reference have the similar status as ELGG 1.9 "... don't use in production ..."
What is most "official" reference to 1.9? I don't ask for documentation, which is clearly
http://learn.elgg.org/en/latest/index.html
I am asking for similar as this for 1.8:
http://reference.elgg.org/index.html
It may be possible to investigate the version from the file
ELGG-root/version.php
but unfortunately data-like-version there does not assure which release it is
In contrary for 1.8 it is clear:
// YYYYMMDD = Elgg Date
// XX = Interim incrementer
$version = 2014012000;
// Human-friendly version name
$release = '1.8.19';
There is a human-useful stamp in file
composer.json,
but unfortunately it is not shown in Files menu in
"doxigen" generator.
I also tried to search this forum by keys:
elgg reference
elgg 1.9 reference
elgg documentation
post: By Cash 1040 days ago
Did you try the Documentation link in the blue toolbar at the top of the page?
which gave no dice.
Having reference on-line without a version is nearly having nothing.
Yes, it may be possible to generate such web-site on own notebook, by
"Command file for Sphinx documentation", and if it is, where to start?
Thank you.
Konstantin.
- Paweł Sroka@srokap
Paweł Sroka - 0 likes
- 1.9 - 1.9.x development (bugfixes only, features are frozen already)
- 1.x - features that are backward compatible
- master - backward incompatible changes
- http://reference.elgg.org/1.5/
- http://reference.elgg.org/1.6/
- http://reference.elgg.org/1.7/
- http://reference.elgg.org/1.8/
- http://reference.elgg.org/1.9/
- http://reference.elgg.org/1.x/
- http://reference.elgg.org/master/
- and http://reference.elgg.org/ is displaying version 1.8
- Konstantin@bitlab
Konstantin - 0 likes
You must log in to post replies.The most recent "stable" version of Elgg is the one from the main page http://elgg.org/ which is 1.8.19 at the moment.
Doxygen-generated reference uses names of branches, so if you see Version master, that means master branch on github and if you see 1.8, it's 1.8 branch (which is NOT exactly the same as last released version). Either way that's only a bunch of html generated from doc blocks, so configuring your IDE to correctly recognize project comments may be more useful for you. I for one, use reference ONLY to point people to the function they can use. I don't remember ever using it during development. But no harm in having it.
Reference does miss branches after our recent reorganization, I'll fix it in few minutes, generally we follow semver now:
Branches 1.9 and 1.x are missing from reference currently.
"Sphinx documentation" is just a source for human readable documentation that is to replace old wiki. It's automatically updated on http://learn.elgg.org/ and is built from several branches independently.
Edit:
I've added new branches to reference.elgg.org, which makes following a full list of versions:
Thank you for your work, Pawel.
Now with peace of mind, i know that "master",
http://reference.elgg.org/master/index.html,
currently means "1.9.0-rc.6".
Yes, above link is important to start, and grep-on-source-code is important to follow.
Konstantin.