Forum Discussion

AbhishekIlindra's avatar
AbhishekIlindra
Boss
9 years ago
Solved

Lithium SDK Clarifications

Hi All,

 

Can anyone explain how Lithium SDK is going to work. Following topics need clarification on it.

 

1. We create new components and pushed to Stage Environment. What are the steps need to perform while pushing code to Production.

2. We have both SDK push Components and New components created in the Stage Environment(with out SDK)  is it going to effect while pushing code via Studio push.

  • SuzieH's avatar
    SuzieH
    9 years ago

    Hi AbhishekIlindra,

    Here is a screenshot to help illustrate. Notice the message at the top. (I highlighted it with the red outline.) That message will help notify you if a component exists in multiple plugins.

     


    As for the two categories (Custom and SDK) in the Components section of the tab...

     

    If you see a component with an SDK icon in the "Custom section, it means that you have two versions of the component -- one in Studio and one in the Community Plugin SDK. If there are any differences in the contents of the component code, then the Studio version is used. If you want to use the SDK version, click the X next to the component (in the Custom section). After you click that X button, the component will appear in the SDK section of the tab. The version in the Studio plugin will be deleted. 

     

     

    If a component only appears in the SDK section, it only exists in the SDK plugin. 

    If a component only appears in the Custom section and does not have an SDK icon next to it, then the component only exists in the Studio plugin.

     

    I suspect what happened is that a set of custom components were originally created in Studio, and then were exported into the SDK using the li export-studio-plugin command. Then, when new components were created and submitted via the SDK with li submit-plugin , the originally-exported components (created in Studio) were submitted back to Stage, resulting in duplicate copies.

     

    If you want all component development to go through the SDK, I would recommend clicking the X button next to duplicate copies in the Custom section so that all components appear under the SDK section. That might help remove confusion when Studio users are looking at the Components tab. 

20 Replies

Show More
  • cike's avatar
    cike
    Champion
    9 years ago

    These paths indicate where the component is created or modified:

     

    SDK shows, that these code is pushed to stage through the SDK.

    Custom indicates all your components, which were created through studio directly.

     

    It shall only help you not to get loss when you want to know where your source code is coming from. :)

  • AbhishekIlindra's avatar
    AbhishekIlindra
    Boss
    9 years ago

    Thank you cike SuzieH now it cleared all my doubts the only concern is i have attached  a screenshot of the components section in the Studio and i'm observing two different path in it one is Custom and one is SDK. Kindly explain me what is the difference in it

  • cike's avatar
    cike
    Champion
    9 years ago

    I think what SuzieH describes, is the fact in some cases your code changes via studio will override those ones made by the SDK. For example, if you create a component via the SDK and update this component through studio directly in the future, your component is "disconnected" from the SDK and only changes made to component via studio will work.

    This behavior fits also for other customizations (e.g. Quilts, Endpoints, ...).

     

    For your customizations everything sounds safe. As SuzieH I would also recommend taking a look at Developer Workflow documentation sites. There you will find more information how the SDK works and which strategies (where to customize your community) exist.

     

    Best regards,

    Christian

  • AbhishekIlindra's avatar
    AbhishekIlindra
    Boss
    9 years ago

    Attaching the screenshot for your reference. We are seeing components and SDK tab in the component


    SDk.PNG
  • AbhishekIlindra's avatar
    AbhishekIlindra
    Boss
    9 years ago

    In the components List we can able to see for few components SDK label has been added next to the components name and for few there is no SDK label

  • AbhishekIlindra's avatar
    AbhishekIlindra
    Boss
    9 years ago

    "As long as you don't have components (or other files) in the SDK that also exist in Studio" can you please elaborate this Point

  • SuzieH's avatar
    SuzieH
    Khoros Alumni (Retired)
    9 years ago

    Hi AbhishekIlindra,

    What you're describing sounds like you will be safe. As long as you don't have components (or other files) in the SDK that also exist in Studio, each item should publish correctly. 

     

    Cheers.

  • AbhishekIlindra's avatar
    AbhishekIlindra
    Boss
    9 years ago

    SuzieH : Thanks for your clarification. To be clear on this content i will little elaborate this:

     

    We are totally re designing the existing skin with brand new one and for that we used Lithium SDK for it and we have few components pushed via SDK and few directly in the Community. We are pushing both the components in the Community at same time.

     

    Let us know is it the right way of doing or we are missing any point.

  • SuzieH's avatar
    SuzieH
    Khoros Alumni (Retired)
    9 years ago

    Hi AbhishekIlindra,

    Have you read through the Developer Workflow section of the SDK documentation?

    You'll use Studio Publish to push components contributed with the SDK live to production, just as you do for other customizations. Once components are on stage, regardless of how they go there (SDK or Studio), Studio Publish is the tool to go live.

     

    Always remember that if you have a component with the same name in both Studio and in the Community Plugin SDK, the version in Studio will override the SDK version. The same document I linked to describes different development strategies with working wth the SDK.

     

    Hope this helps.