Skip to content
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

Documentation content repositories: place images in the right folder #620

Open
9 of 16 tasks
tbouffard opened this issue Sep 18, 2023 · 3 comments
Open
9 of 16 tasks
Labels
doc-content hacktoberfest Can be done during the Hacktoberfest

Comments

@tbouffard
Copy link
Member

tbouffard commented Sep 18, 2023

Today, the images are placed in several repositories in assets/images/images instead of images

The assets folder is optional as of Antora 2.1: see https://gitlab.com/antora/antora/-/blob/v2.1.x/docs/modules/ROOT/pages/whats-new.adoc?ref_type=heads#user-content-the-assets-folder-is-now-optional
We used this extra assets folder at the Antora site initialization. We probably used it because we start from an existing project using it (couchbase).

About the "double" images folder, see https://github.com/bonitasoft/bonita-documentation-site/blob/5c29b1e1ce8f05d255ebad76eb6c625d5e35b27c/docs/migrate-from-old-documentation-site/doc-content-conversion-from-md-to-adoc.adoc#move-images

Review the repository and move the images

Warning: for components with several versions

  • start from the older supported version: create a Pull Request for the oldest version
  • wait for this PR to be merged, DO NOT create a PR for other versions. The changes must be first propagated to newer versions. This is done every night or on demand (ask the repository maintainers if you're in a hurry).
  • once the changes have been propagated, and if newer versions required other changes, create a new PR for the oldest versions requiring changes
  • iterate until all versions have been updated

Tasks follow-up:

@tbouffard tbouffard added doc-content hacktoberfest Can be done during the Hacktoberfest labels Sep 18, 2023
@ShatilKhan
Copy link

Please assign me, I've done doc contributions before

@tbouffard
Copy link
Member Author

Hi @ShatilKhan and thanks for your proposal. You are now assigned to this issue.

Feel free to ask questions here if you need clarification.
Please follow the guidelines about the creation of the Pull Request which is mentioned in the description of this issue.

@tbouffard
Copy link
Member Author

Unassign @ShatilKhan due to no activity.

benjaminParisel pushed a commit to bonitasoft/bonita-doc that referenced this issue Nov 27, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the
standard Antora folder.

Covers
bonitasoft/bonita-documentation-site#620
benjaminParisel pushed a commit to bonitasoft/bonita-doc that referenced this issue Nov 27, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the
standard Antora folder.


Covers
bonitasoft/bonita-documentation-site#620
benjaminParisel pushed a commit to bonitasoft/bonita-doc that referenced this issue Nov 27, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the
standard Antora folder.


Covers
bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Nov 27, 2024
…2916)

* Delete the unused  image
* Homogenize the way of writing the troubleshooting section

Covers
bonitasoft/bonita-documentation-site#620
benjaminParisel pushed a commit to bonitasoft/bonita-doc that referenced this issue Nov 27, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the
standard Antora folder.


Covers
bonitasoft/bonita-documentation-site#620
benjaminParisel pushed a commit to bonitasoft/bonita-doc that referenced this issue Nov 27, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the
standard Antora folder.


Covers
bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Nov 27, 2024
The images were stored in the Antora legacy folder (assets/images) and included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Nov 29, 2024
The images were stored in the Antora legacy folder (assets/images) and included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Nov 29, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the
standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Dec 2, 2024
The images were stored in the Antora legacy folder (assets/images) and included an extra "images" sub-folder.
All images are now in the "images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Dec 2, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder. All images are now in the
"images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Dec 2, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder. All images are now in the
"images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Dec 3, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder. All images are now in the
"images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Dec 4, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder. All images are now in the
"images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
benjaminParisel added a commit to bonitasoft/bonita-doc that referenced this issue Dec 4, 2024
The images were stored in the Antora legacy folder (assets/images) and
included an extra "images" sub-folder. All images are now in the
"images" folder of the module, which is the standard Antora folder.

Covers bonitasoft/bonita-documentation-site#620
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-content hacktoberfest Can be done during the Hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants