Skip to content

[ADD] version control doc #5262

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
Closed
wants to merge 1 commit into from
Closed

[ADD] version control doc #5262

wants to merge 1 commit into from

Conversation

@Felicious
Copy link
Contributor

@Felicious Felicious commented Aug 3, 2023 •
edited
Loading

Summary

Add a new PLM doc about:

  1. Viewing version of production BoM
  2. Checking revision history of BoMs
  3. Updating design files
  4. Merging changes to the production BoM using Apply Rebase

Things to look out for:

  1. Any suggestions on additional examples of version control tools PLM has? I tried to be exhaustive, but I might be missing something!
  2. Most of our documentation has 1 page for 1 feature, and I threw a bunch of features together with a generic title "Version control". Is this the right way to go? Should I break this doc up into smaller docs? Any suggestions on a more specific document title?
  3. What did you think of my explanation of merging and branching? (lines 118-142)

Alert

This PR should be merged after the ECO PR. This PR references some links made in this doc, so please ignore the custom anchor errors (:

The custom anchors:
image

@robodoo
Copy link
Collaborator

robodoo commented Aug 3, 2023

Pull request status dashboard.

@C3POdoo C3POdoo requested a review from a team August 3, 2023 22:51
@Felicious Felicious force-pushed the 16.0-plm-document-management-feku branch from c3d1dac to d3e71a5 Compare August 3, 2023 23:06
@Felicious Felicious self-assigned this Aug 3, 2023
@brse-odoo brse-odoo self-requested a review August 7, 2023 12:55
brse-odoo
brse-odoo reviewed Aug 7, 2023
View reviewed changes
Copy link
Contributor

@brse-odoo brse-odoo left a comment

Choose a reason for hiding this comment

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

@Felicious I've finished my review of this PR. Great job! It's very straightforward, clear, and easy to understand. The suggestions I left were small, I didn't have anything major to add. As always, feel free to accept/reject them as you see fit and ping me with any questions. Thanks!

@Felicious Felicious force-pushed the 16.0-plm-document-management-feku branch 2 times, most recently from f1bfb87 to a88262f Compare August 8, 2023 23:10
@Felicious Felicious requested a review from brse-odoo August 8, 2023 23:16
@odoo-shke odoo-shke self-requested a review August 10, 2023 18:39
odoo-shke
odoo-shke reviewed Aug 10, 2023
View reviewed changes
Copy link
Contributor

@odoo-shke odoo-shke left a comment

Choose a reason for hiding this comment

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

Looks good to me!

brse-odoo
brse-odoo reviewed Aug 23, 2023
View reviewed changes
Copy link
Contributor

@brse-odoo brse-odoo left a comment

Choose a reason for hiding this comment

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

@Felicious, I've just finished my second review of this PR. Great job! I had very few comments this time around, and this doc is really tight now. Let me know if you have any other questions!

@Felicious Felicious force-pushed the 16.0-plm-document-management-feku branch from 07f34ae to fff1fc9 Compare August 28, 2023 21:28
@Felicious Felicious requested a review from a team August 28, 2023 21:29
@Felicious
Copy link
Contributor Author

Felicious commented Aug 28, 2023

Hello @odoo/crm-doc-review ! This new doc for PLM is ready for your second round of peer review! There's a custom anchor for my first PLM doc I'm adding (engineering change orders) that's causing the CI/Documentation test to fail. Lmk if you see issues other than the missing custom anchors; I'll address them (:

Thanks in advance for your help! (:

ksc-odoo
ksc-odoo reviewed Aug 29, 2023
View reviewed changes
Copy link
Contributor

@ksc-odoo ksc-odoo left a comment

Choose a reason for hiding this comment

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

@Felicious hey there - just finished my peer review of this doc. nice work! once you take a look at my suggestions, I believe this will be ready for the next stage. 👍

Felicious
Felicious commented Aug 30, 2023
View reviewed changes
@Felicious Felicious force-pushed the 16.0-plm-document-management-feku branch from 9111b83 to 9d6a9d2 Compare August 30, 2023 20:11
@Felicious
Copy link
Contributor Author

Felicious commented Aug 30, 2023

Hi @odoo/us-doc-review ! This PLM doc is ready for your review (:

Just to let you know, the errors in the CI checks are from missing custom anchors since this doc references the other PLM docs I've written and are unpublished.

Also, you can read the latest version of this doc in this github staging environment! Just left the link here for your reviewing convenience (:

@Felicious Felicious requested a review from a team August 30, 2023 21:00
@StraubCreative
Copy link
Contributor

StraubCreative commented Sep 18, 2023

@Felicious can you look at the failing check here please

@Felicious
Copy link
Contributor Author

Felicious commented Sep 18, 2023

@StraubCreative As mentioned in the Alert section of the summary, the missing custom anchors refer to links to unpublished ECO docs like:

  1. engineering change orders
  2. eco approvals

So the error would go away after the eco doc is published

@StraubCreative
Copy link
Contributor

StraubCreative commented Sep 18, 2023

@Felicious ok makes sense. Working to get the other docs published first before this one then so we can bypass the failing check.

@Felicious Felicious force-pushed the 16.0-plm-document-management-feku branch from 9d6a9d2 to ecb49dd Compare October 12, 2023 17:49
@C3POdoo C3POdoo requested review from a team October 12, 2023 17:51
@Felicious Felicious removed the request for review from a team October 12, 2023 17:51
@Felicious Felicious removed the request for review from a team October 12, 2023 17:51
@Felicious @StraubCreative
[ADD] PLM: version control
3b5e11b 
Author:    Felicious <feku@odoo.com>
@StraubCreative StraubCreative force-pushed the 16.0-plm-document-management-feku branch from ecb49dd to 3b5e11b Compare November 3, 2023 16:07
StraubCreative
StraubCreative approved these changes Nov 3, 2023
View reviewed changes
Copy link
Contributor

@StraubCreative StraubCreative left a comment

Choose a reason for hiding this comment

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

Great doc @Felicious 👏

@robodoo r+

robodoo pushed a commit that referenced this pull request Nov 3, 2023
@Felicious @StraubCreative
[ADD] PLM: version control
bca6ab8 
closes #5262

Author:    Felicious <feku@odoo.com>
Signed-off-by: Zachary Straub (zst) <zst@odoo.com>
@robodoo
Copy link
Collaborator

robodoo commented Nov 3, 2023

@Felicious @StraubCreative staging failed: ci/runbot on ff3e20bc76d4c4c43ab8dec39635fbbda220eb0e (view more at https://runbot.odoo.com/runbot/build/53275386)

@StraubCreative
Copy link
Contributor

StraubCreative commented Nov 3, 2023

@robodoo retry

@robodoo robodoo closed this in 6a5c340 Nov 3, 2023
This was referenced Nov 3, 2023
Closed
Closed
Closed
Closed
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StraubCreative StraubCreative StraubCreative approved these changes

+3 more reviewers

@ksc-odoo ksc-odoo ksc-odoo left review comments

@odoo-shke odoo-shke odoo-shke left review comments

@brse-odoo brse-odoo brse-odoo left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@Felicious Felicious

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Felicious @robodoo @StraubCreative @ksc-odoo @odoo-shke @brse-odoo