Skip to content

Conversation

@julitafalcondusza
Copy link
Contributor

@julitafalcondusza julitafalcondusza commented Aug 27, 2024

Question Answer
JIRA Ticket IBX-8590
Versions 4.6+

Reorganizing documentation in terms of Product Guides:

  • new landing pages
  • naming
  • structure update
  • mkdocs update
  • new "Product guides" landing page added

Previews:

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Added link to this PR in relevant JIRA ticket or code PR

adriendupuis

This comment was marked as duplicate.

Copy link
Contributor

@adriendupuis adriendupuis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I navigate through all new pages. See the "preview" list I added to the PR desc to see if I missed something. I checked navigation and general aspect. New meta descriptions (used by cards) seemed OK to me but I didn't had a very close look at them in this pass.

https://ez-systems-developer-documentation--2479.com.readthedocs.build/en/2479/content_management/rich_text/rich_text/ is missing from the mkdocs.yml TOC

https://ez-systems-developer-documentation--2479.com.readthedocs.build/en/2479/content_management/forms/forms/ is crashing due to a typo in a path ("atrr" instead of "attr").

@julitafalcondusza
Copy link
Contributor Author

@dabrt, thanks for the review.
All the suggestions regarding sentences/structure/spacing/additional links or tips inside of the articles are out of scope of this PR, so I only took into account typos and punctuation.

@dabrt
Copy link
Contributor

dabrt commented Aug 28, 2024

@dabrt, thanks for the review. All the suggestions regarding sentences/structure/spacing/additional links or tips inside of the articles are out of scope of this PR, so I only took into account typos and punctuation.

obraz

Copy link
Contributor

@mnocon mnocon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like this, this is the cherry on top that ties all the product edition guides together ⭐

I've left some suggestions how I believe we can improve it.

Great idea with the features table!

Copy link
Contributor

@mnocon mnocon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks great now!

(I'm assumign the comment from Adrien will be taken into account, please note that the Personalization PG has been renamed as well)

@julitafalcondusza julitafalcondusza merged commit 2d99f7f into master Aug 30, 2024
@julitafalcondusza julitafalcondusza deleted the IBX-8590 branch August 30, 2024 12:09
julitafalcondusza added a commit that referenced this pull request Aug 30, 2024
* Fixes: new cards, mkdocs updated

* Updates

* New description, updates

* Typo fix

* Fixes after rev

* Fixes after rev

* Updates in the features table, fixes

* Redirects fixed

* Fix

* Fix - docs removed from the redirect path
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants