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

Migrate important content from Optimize 8 documentation to Optimize 7 3.14 #4780

Open
4 tasks
Tracked by #4716
mboskamp opened this issue Nov 8, 2024 · 3 comments
Open
4 tasks
Tracked by #4716
Assignees
Labels
type:subtask Issues that are subtasks of another issue. Must always be part of the breakdown of the parent issue.

Comments

@mboskamp
Copy link
Member

mboskamp commented Nov 8, 2024

Acceptance Criteria (Required on creation)

The Optimize 3.14 documentation branch is a copy of the 3.8 branch. We need to identify major updates and migrate them on a best-effort basis. We can always iterate and migrate more in the future.

Hints

Links

Breakdown

Pull Requests

@mboskamp mboskamp added the type:subtask Issues that are subtasks of another issue. Must always be part of the breakdown of the parent issue. label Nov 8, 2024
@mboskamp mboskamp self-assigned this Nov 8, 2024
@mboskamp
Copy link
Member Author

mboskamp commented Nov 13, 2024

What content do we want to migrate?

  • Update/Migration guides
  • Dependency Information
  • Installation guide
  • Features
    • OpenSearch support: This feature has impact on many aspects of the documentation. It's an alternative DB (next to Elasticsearch), so in all places where we talk about Elasticsearch, we need to include OpenSearch or generically talk about "databases".
    • other features?

What happened so far?

@mboskamp
Copy link
Member Author

I don't intend to squash the commits in the PRs. It will be helpful to have the history on the branches. We would have a similar history if the branches had been created through a regular release.

@psavidis psavidis assigned mboskamp and unassigned psavidis Nov 18, 2024
@mboskamp
Copy link
Member Author

@psavidis, I did not try out the Python link validator. However, I tested the pages with broken links and found no issues.
I had to battle with Git a lot to get a clean history. All the hashes are probably different due to history rewrites.
The main changes are:

@mboskamp mboskamp assigned psavidis and unassigned mboskamp Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:subtask Issues that are subtasks of another issue. Must always be part of the breakdown of the parent issue.
Projects
None yet
Development

No branches or pull requests

2 participants