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

247 Update pipeline documentation #266

Merged
merged 11 commits into from
Oct 4, 2024

Conversation

MustafaJafar
Copy link
Contributor

Changelog Description

This PR:

Additional info

We may not need to explain the difference between update pipeline and server bootstrapping because server bootstrapping no longer exists as far as I know.

Testing notes:

  1. Read through the changes.
  2. Approve if they make sense to you.

@MustafaJafar MustafaJafar requested a review from BigRoy October 3, 2024 13:05
Copy link
Member

@Innders Innders left a comment

Choose a reason for hiding this comment

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

Nice one! I have made some very minor changes for you to approve.

Could you please use this image instead of the currently vertical one. It looks slightly nicer and will flow with the page better as it's landscape.

update_pipeline_release

Could we please also mention that a new bundle will be created for the new release, but it's up to you to test it and put it in production.

Do we have documentation on migrating settings between addons? This tools is best used alongside the copy settings between bundles tool and it would be great to reference that here.

The most likely workflow is:

  1. Use Update Pipeline tool.
  2. Use Copy bundle settings tool to copy settings to new release bundle.
  3. Test new bundle and set to production.

To do list:

  • Approve suggestions
  • Use new image
  • Document new bundle is created after finishing update
  • Mention that the next steps would be to use the Copy Bundle Settings Tool, test and set to production. (In the future we can link to more details docs)

website/docs/admin_server_updating_pipeline.md Outdated Show resolved Hide resolved
website/docs/admin_server_updating_pipeline.md Outdated Show resolved Hide resolved
@MustafaJafar MustafaJafar requested a review from Innders October 3, 2024 21:12
@MustafaJafar
Copy link
Contributor Author

@Innders Thanks a ton for your suggestions. I've pushed more updates.

Copy link
Member

@Innders Innders left a comment

Choose a reason for hiding this comment

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

Great stuff, just some tiny changes to make it perfect 👌

website/docs/admin_server_updating_pipeline.md Outdated Show resolved Hide resolved
website/docs/admin_server_updating_pipeline.md Outdated Show resolved Hide resolved
@MustafaJafar MustafaJafar requested a review from Innders October 3, 2024 21:38
@MustafaJafar MustafaJafar merged commit f3719ff into main Oct 4, 2024
2 checks passed
@MustafaJafar MustafaJafar deleted the 247-update-pipeline-documentation branch October 4, 2024 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Pipeline documentation
3 participants