-
Notifications
You must be signed in to change notification settings - Fork 10.3k
[REF][MOV] documentation apocalypse #945
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AntoineVDV
added a commit
that referenced
this pull request
Apr 30, 2021
Prior to this commit, the Odoo documentation was mainly split between two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...). This was causing several problems among which: - The theme, config, Makefile, and similar technical resources had to be duplicated. This resulted in inconsistent layout, features, and build environments from one documentation to another. - Some pages did not fit either documentation as they were relevant for both users and developers. Some were relevant to neither of the two (e.g., DB management). - Cross-doc references had to be absolute links and they broke often. - Merging large image files in the developer documentation would bloat the odoo/odoo repository. Some contributions had to be lightened to avoid merging too many images (e.g., Odoo development tutorials). - Long-time contributors to the user documentation were chilly about going through the merging process of the developer documentation because of the runbot, mergebot, `odoo-dev` repository, etc. - Some contributors would look for the developer documentation in the `odoo/documentation-user` repository. - Community issues about the user documentation were submitted on the `odoo/odoo` repository and vice-versa. Merging all documentations in one repository will allow us to have one place, one theme, one work process, and one set of tools (build environment, ...) for all of the Odoo docs. As this is a good opportunity to revamp the layout of the documentation, a brand new theme replaces the old one. It features a new way to navigate the documentation, centered on the idea of always letting the reader know what is the context (enclosing section, child pages, page structure ...) of the page they are reading. The previous theme would quickly confuse readers as they navigated the documentation and followed cross-application links. The chance is also taken to get rid of all the technical dangling parts, performance issues, and left-overs. Except for some page-specific JS scripts, the Odoo theme Sphinx extension is re-written from scratch based on the latest Sphinx release to benefit from the improvements and ease future contributions. task-2351938 task-2352371 task-2205684 task-2352544 Closes #945 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Elisabeth Dickinson <edi@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
ea52fdf
to
9d2c47c
Compare
Feyensv
pushed a commit
that referenced
this pull request
May 3, 2021
Prior to this commit, the Odoo documentation was mainly split between two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...). This was causing several problems among which: - The theme, config, Makefile, and similar technical resources had to be duplicated. This resulted in inconsistent layout, features, and build environments from one documentation to another. - Some pages did not fit either documentation as they were relevant for both users and developers. Some were relevant to neither of the two (e.g., DB management). - Cross-doc references had to be absolute links and they broke often. - Merging large image files in the developer documentation would bloat the odoo/odoo repository. Some contributions had to be lightened to avoid merging too many images (e.g., Odoo development tutorials). - Long-time contributors to the user documentation were chilly about going through the merging process of the developer documentation because of the runbot, mergebot, `odoo-dev` repository, etc. - Some contributors would look for the developer documentation in the `odoo/documentation-user` repository. - Community issues about the user documentation were submitted on the `odoo/odoo` repository and vice-versa. Merging all documentations in one repository will allow us to have one place, one theme, one work process, and one set of tools (build environment, ...) for all of the Odoo docs. As this is a good opportunity to revamp the layout of the documentation, a brand new theme replaces the old one. It features a new way to navigate the documentation, centered on the idea of always letting the reader know what is the context (enclosing section, child pages, page structure ...) of the page they are reading. The previous theme would quickly confuse readers as they navigated the documentation and followed cross-application links. The chance is also taken to get rid of all the technical dangling parts, performance issues, and left-overs. Except for some page-specific JS scripts, the Odoo theme Sphinx extension is re-written from scratch based on the latest Sphinx release to benefit from the improvements and ease future contributions. task-2351938 task-2352371 task-2205684 task-2352544 Closes #945
9d2c47c
to
f06f0a6
Compare
Feyensv
added a commit
that referenced
this pull request
May 3, 2021
This is the port for 14.0. See #945 for more details. COM PR: odoo/odoo#70178 task-2351938 task-2352371 task-2205684 task-2352544 Closes #948 Co-authored-by: Victor Feyens<vfe@odoo.com> Co-authored-by: Elisabeth Dickinson<edi@odoo.com> Co-authored-by: Antoine Vandevenne<anv@odoo.com>
Feyensv
added a commit
that referenced
this pull request
May 3, 2021
This is the port for master. See #945 for more details. COM PR: odoo/odoo#70256 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Elisabeth Dickinson <edi@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
AntoineVDV
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2352371 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
AntoineVDV
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As c99629b removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
AntoineVDV
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
AntoineVDV
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As 6709e1a removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
AntoineVDV
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
AntoineVDV
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As de86b3f removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As c99629b removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes #70121 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Feyensv
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2352371 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Feyensv
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As c99629b removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes odoo#70121 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As 6709e1a removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes #70174 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As de86b3f removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes #70178 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2352371 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As c99629b removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes #70121 closes #70341 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com> Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As d4ba311 removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes #70256 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Feyensv
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Feyensv
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As de86b3f removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes odoo#70178 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 4, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As de86b3f removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes #70178 closes #70348 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Feyensv
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 5, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Feyensv
added a commit
to odoo-dev/odoo
that referenced
this pull request
May 5, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As de86b3f removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes odoo#70178 closes odoo#70348 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 5, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
robodoo
pushed a commit
to odoo/odoo
that referenced
this pull request
May 5, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As de86b3f removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes #70178 closes #70348 closes #70358 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
zel-odoo
pushed a commit
to odoo-dev/odoo
that referenced
this pull request
May 12, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
zel-odoo
pushed a commit
to odoo-dev/odoo
that referenced
this pull request
May 12, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As d4ba311 removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes odoo#70256 Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
zel-odoo
pushed a commit
to odoo-dev/odoo
that referenced
this pull request
May 18, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2351938 task-2352371 task-2205684 task-2352544 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
kzhekov
pushed a commit
to odoo-dev/odoo
that referenced
this pull request
Jun 28, 2021
In odoo/documentation#945, the developer documentation is merged with the user documentation in a single repository and build config. This commit then removes source files for the developer documentation from the odoo/odoo repository. DOC PR: odoo/documentation#945 task-2352371 Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
kzhekov
pushed a commit
to odoo-dev/odoo
that referenced
this pull request
Jun 28, 2021
The only purpose of the module `test_documentation_examples` is to test a few of the code examples shown in the developer documentation. As c99629b removes the documentation sources from the repository, the test module is removed as well. DOC PR: odoo/documentation#945 task-2352371 closes odoo#70121 Signed-off-by: Martin Trigaux (mat) <mat@odoo.com> Co-authored-by: Victor Feyens <vfe@odoo.com> Co-authored-by: Antoine Vandevenne <anv@odoo.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
going through the merging process of the developer documentation
because of the runbot, mergebot,
odoo-dev
repository, etc.odoo/documentation-user
repository.odoo/odoo
repository and vice-versa.Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
COM PR : odoo/odoo#70121
task-2351938
task-2352371
task-2205684
task-2352544
Co-authored-by: Victor Feyens vfe@odoo.com
Co-authored-by: Elisabeth Dickinson edi@odoo.com
Co-authored-by: Antoine Vandevenne anv@odoo.com