Diffusion invenio-infoscience 933fae4a5e44

docs: new documentation structure
933fae4a5e44
Actions

Authored by Tibor Simko <tibor.simko@cern.ch> on Oct 9 2015, 15:21.

Description

docs: new documentation structure

BETTER Introduces new enchired documentation structure, imports selected documentation from the old project web site, and improves parts of the existing documentation. (closes #1799)

Signed-off-by: Tibor Simko <tibor.simko@cern.ch>

Details

Committed

Tibor Simko <tibor.simko@cern.ch>

Oct 12 2015, 14:15

Parents

R3600:dfdccaf81a68: travis: retain documentation building only

Branches

Unknown

Tags

Unknown

Event Timeline

Tibor Simko <tibor.simko@cern.ch> committed R3600:933fae4a5e44: docs: new documentation structure (authored by Tibor Simko <tibor.simko@cern.ch>).Oct 12 2015, 14:15

Changes (91)

		Path
M		ABOUT-NLS
M		INSTALL.rst
A		docs/_static/modules-overview-diagram.jpeg
D		docs/admin
V		docs/{admin → architecture}/index.rst
D		docs/admin/webstyle-admin-guide.rst
V		docs/{api.rst → technology/index.rst}
A	(dir)	docs/architecture/
V		docs/{architecture ← admin}/index.rst
V		docs/{architecture/module-anatomy-models.rst ← developers/models.rst}
V		docs/{architecture/module-anatomy-structure.rst ← developers/howtomodule.rst}
V		docs/{architecture/module-anatomy-templates.rst ← developers/templates.rst}
V		docs/{architecture/module-anatomy-views.rst ← developers/howtomodulepart2.rst}
V		docs/{architecture/module-anatomy.rst ← developers/howtomodulepart3.rst}
P		docs/architecture/package-anatomy-base.rst Copied from docs/deprecationpolicy.rst
V		docs/{architecture/package-anatomy-extensions.rst ← developers/extensions.rst}
V		docs/{architecture/package-anatomy-modules.rst ← developers/modules.rst}
V		docs/{architecture/package-anatomy-utilities.rst ← developers/patterns.rst}
V		docs/{architecture/package-anatomy.rst ← getting-started/index.rst}
V		docs/{architecture/system-framework.rst ← index.rst}
A		docs/architecture/system-overview.rst
V		docs/{authors.rst ← developers/kwalitee.rst}
P		docs/community/blogs.rst Copied from docs/community/index.rst
A		docs/community/chatrooms.rst
P		docs/community/forum.rst Copied from docs/community/index.rst
P		docs/community/index.rst Copied to multiple locations: docs/community/blogs.rst docs/community/forum.rst docs/community/twitter.rst docs/configuration/index.rst docs/installation/index.rst docs/introduction/index.rst docs/processes/developing.rst docs/processes/index.rst docs/processes/merging.rst docs/processes/releasing.rst docs/processes/reporting.rst
A		docs/community/mailinglists.rst
P		docs/community/twitter.rst Copied from docs/community/index.rst
A	(dir)	docs/configuration/
P		docs/configuration/index.rst Copied from docs/community/index.rst
V		docs/{configuration ← getting-started}/overlay.rst
D		docs/contents.rst.inc
P		docs/deprecationpolicy.rst Deleted after being copied to multiple locations: docs/architecture/package-anatomy-base.rst docs/technology/i18n.rst
D		docs/developers
V		docs/{developers → technology}/docker.rst
V		docs/{developers/extensions.rst → architecture/package-anatomy-extensions.rst}
V		docs/{developers/git-workflow.rst → technology/git.rst}
V		docs/{developers/howtomodule.rst → architecture/module-anatomy-structure.rst}
V		docs/{developers/howtomodulepart2.rst → architecture/module-anatomy-views.rst}
V		docs/{developers/howtomodulepart3.rst → architecture/module-anatomy.rst}
V		docs/developers/index.rst
D		docs/developers/introduction.rst
V		docs/{developers/kwalitee.rst → authors.rst}
V		docs/{developers/models.rst → architecture/module-anatomy-models.rst}
V		docs/{developers/modules.rst → architecture/package-anatomy-modules.rst}
V		docs/{developers/patterns.rst → architecture/package-anatomy-utilities.rst}
D		docs/developers/registries.rst
V		docs/{developers/templates.rst → architecture/module-anatomy-templates.rst}
V		docs/{developers/tutorial.rst → modules/index.rst}
D		docs/getting-started
V		docs/{getting-started → technology}/common-concepts.rst
V		docs/{getting-started → introduction}/demo.rst
V		docs/{getting-started → introduction}/features.rst
V		docs/{getting-started/first-steps.rst → installation/installation-detailed.rst}
V		docs/{getting-started/index.rst → architecture/package-anatomy.rst}
D		docs/getting-started/introduction.rst
V		docs/{getting-started → configuration}/overlay.rst
V		docs/{getting-started/quickstart.rst → introduction/about.rst}
V		docs/{index.rst → architecture/system-framework.rst}
A	(dir)	docs/installation/
P		docs/installation/index.rst Copied from docs/community/index.rst
V		docs/{installation/installation-detailed.rst ← getting-started/first-steps.rst}
A		docs/installation/installation-quick.rst
V		docs/{installation/upgrades.rst ← upgrading.rst}
A	(dir)	docs/introduction/
V		docs/{introduction/about.rst ← getting-started/quickstart.rst}
V		docs/{introduction ← getting-started}/demo.rst
V		docs/{introduction ← getting-started}/features.rst
P		docs/introduction/index.rst Copied from docs/community/index.rst
A		docs/introduction/releases.rst
D		docs/legacy
D		docs/legacy/bibrecord.rst
M		docs/license.rst
A	(dir)	docs/modules/
V		docs/{modules/index.rst ← developers/tutorial.rst}
A		docs/modules/list.rst
A	(dir)	docs/processes/
P		docs/processes/developing.rst Copied from docs/community/index.rst
P		docs/processes/index.rst Copied from docs/community/index.rst
P		docs/processes/merging.rst Copied from docs/community/index.rst
P		docs/processes/releasing.rst Copied from docs/community/index.rst
P		docs/processes/reporting.rst Copied from docs/community/index.rst
A		docs/processes/triaging.rst
A	(dir)	docs/technology/
V		docs/{technology ← getting-started}/common-concepts.rst
V		docs/{technology ← developers}/docker.rst
V		docs/{technology/git.rst ← developers/git-workflow.rst}
V		docs/{technology/i18n.rst ← deprecationpolicy.rst}
V		docs/{technology/index.rst ← api.rst}
A		docs/technology/python.rst
V		docs/{upgrading.rst → installation/upgrades.rst}