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

chore(user-guide): separate History and History cleanup pages #1580

Merged
merged 1 commit into from
Feb 27, 2024
Merged

chore(user-guide): separate History and History cleanup pages #1580

merged 1 commit into from
Feb 27, 2024

Conversation

yanavasileva
Copy link
Member

@yanavasileva yanavasileva commented Jan 15, 2024 •
edited
Loading

camunda/camunda-bpm-platform#4031

TODO:

Tasks
Preview Give feedback

@yanavasileva yanavasileva self-assigned this Jan 15, 2024
@yanavasileva yanavasileva mentioned this pull request Jan 15, 2024
Closed
1 task
@yanavasileva yanavasileva marked this pull request as ready for review February 13, 2024 15:08
@yanavasileva
Copy link
Member Author

Made changes:

@yanavasileva
Copy link
Member Author

I will send the PR for technical writer review too.

@psavidis
Copy link
Contributor

psavidis commented Feb 21, 2024 •
edited
Loading

Reviewed the link for custom history level, looks good 👍

@yanavasileva
Copy link
Member Author

Hi @christinaausley,

I would like to request a Technical writer review. Make changes overview: #1580 (comment)
Most of the content is existing documentation, so I want to ask you for specific feedback on:

  • page names,
  • paragraph names, and
  • how they fit together after splitting the current History page.

Best,
Yana

christinaausley
christinaausley reviewed Feb 23, 2024
View reviewed changes
content/user-guide/process-engine/history/custom-implementation.md Outdated

---

# Provide a custom history backend
Copy link
Contributor

@christinaausley christinaausley Feb 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

We can't have H1 headers to open our docs, so this should start with an H2. Can you adjust across this doc, and I'll have another look over the content?

Copy link
Contributor

Choose a reason for hiding this comment

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

I could be wrong here, in that we can do this within our C7 docs, but wanted to flag in case the structuring is off.

christinaausley
christinaausley reviewed Feb 23, 2024
View reviewed changes
Copy link
Contributor

@christinaausley christinaausley left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Really big work here, nice job and thank you for getting started!

Are you solely looking for review of the headers here? Or content as well? When does this need to go live/what is your deadline? I want to take my time reviewing this, but don't want to block anything in the works.

@yanavasileva yanavasileva force-pushed the 4031-separate-history-cleanup-page branch from 6e677f0 to 1be9c11 Compare February 26, 2024 14:51
@yanavasileva
Copy link
Member Author

yanavasileva commented Feb 26, 2024 •
edited
Loading

As discussed, the PR has focus on splitting the History page, so I look for feedback on the headers and pages.
Re: timeline, I can keep this PR open till the end of the week. For backport I will apply any changes after this review is done.

christinaausley
christinaausley approved these changes Feb 26, 2024
View reviewed changes
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

I'm good with this 👍

Do you have any user feedback on the headers, or that they feel they aren't comprehensive? I would wait to change them (though I don't see a need quite yet) so users can get used to the new layout anyways.

@yanavasileva
Copy link
Member Author

Do you have any user feedback on the headers, or that they feel they aren't comprehensive?

No, nothing specific. I will pay attention in the forum and tickets if anything pops up after we apply the above changes.

psavidis
psavidis approved these changes Feb 27, 2024
View reviewed changes
Copy link
Contributor

@psavidis psavidis left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Great job! Couldn't find anything missing or broken 👍

PS: There is a conflict that needs to be resolved.

@yanavasileva
Copy link
Member Author

Conflict will be resolved in next commits:

@yanavasileva
chore(user-engine): mention mandatory TTL
caab31e 
* document mandatory TTL
* adjust paragraph names
* adjust references
* add link to custom history level
* new pages:
  * History configuration
  * User operation log
  * History cleanup
  * Custom implementation
  * index page will be loaded when link to the old page can't be resolved

camunda/camunda-bpm-platform#4031
@yanavasileva yanavasileva force-pushed the 4031-separate-history-cleanup-page branch from ab26d18 to caab31e Compare February 27, 2024 09:26
@yanavasileva yanavasileva merged commit 98df5f9 into master Feb 27, 2024
1 check passed
@yanavasileva yanavasileva deleted the 4031-separate-history-cleanup-page branch February 27, 2024 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christinaausley christinaausley christinaausley approved these changes

@psavidis psavidis psavidis approved these changes

Assignees

@yanavasileva yanavasileva

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@yanavasileva @psavidis @christinaausley