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.

Sign up for GitHub

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

Jump to bottom

Additional documentation for tours: how to create the What's New tour and prepare it for a Joomla release #370

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

Additional documentation for tours: how to create the What's New tour and prepare it for a Joomla release #370

wants to merge 17 commits into from

Conversation

obuisard
Copy link
Contributor

No description provided.

@obuisard obuisard added the documentation Improvements or additions to documentation label Jan 26, 2025
@obuisard obuisard requested a review from sdwjoomla January 26, 2025 17:38
sdwjoomla
sdwjoomla approved these changes Feb 6, 2025
View reviewed changes
Copy link

@sdwjoomla sdwjoomla left a comment

Choose a reason for hiding this comment

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

Have to make sure to look closely at X_Y, X.Y and X.YY.

@HLeithner
Copy link
Member

Some annotations.

  • Every file needs a h1 headline underlined with =
  • Please don't use "timebased or version based" information, things like "Since version 4.3...." just write the docs that the feature exists. Reason is that in 2 years nobody is interested in when the feature has been added.
  • if you use code blocks please add the language and may add a headline for it, example ```sql title="uninstall previous tours"
  • if you like to have the mysql and postgresql more compact you can use tabs

HLeithner
HLeithner requested changes Feb 8, 2025
View reviewed changes
Copy link
Member

@HLeithner HLeithner left a comment

Choose a reason for hiding this comment

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

  • Add Headline 1 with =
  • Remove 4.3 introduction statement

@HLeithner
Copy link
Member

I updated the syntax a bit and versions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HLeithner HLeithner HLeithner requested changes

@sdwjoomla sdwjoomla sdwjoomla approved these changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@obuisard @HLeithner @sdwjoomla