Import And Export Community Elements

You can share elements you create using our open Github repository and also directly send a request to publish your element to our Open Developer Community. Therefore, the process of having to export the element you created or sending a pull request to Github is automated.

Import a Community element

You can import elements from our Open Developer Github Repository to your user account, one element at a time.

  1. On Cloud Elements UI, click 'elements' on the navigation panel. You can see three tabs - All, Private and Community, as shown below.
  2. Go to the 'Community' tab. You will see a list of all the elements that are present in the repository.
  3. Navigate to your element, click 'Import' . In the example shown below, we're importing a demo element.
  4. This action makes a call to Github and gets all the details of the element.
  5. Select all the resources you want to import. Click 'Import'. Your element will be imported to your private account.

Export a Community Element

You can export your element to our community repository in Github. To export an element, you need to either already have a Github instance or create one. 

  1. On Cloud Elements UI, click 'elements' on the navigation panel. You can see three tabs - All, Private and Community, as shown below.
  2. You will be see all your element under the 'Private' tab. Hover on the element you want to export, click API Docs and on the page that appears, go to the 'Publish' tab. 
  3. Before you export an element into our repository you need to validate it against some standards set by Cloud Elements. 
  4. Click on 'Run Validation'. This validates the element's swagger and element.json file.
  5. If the validation is successful and you already have an instance provisioned with Github, you can export the element using that instance. The instance must include a tag named "Community-Instance".
  6. If the validation results in an error, click 'Fix Errors'. The 'Publish' button is disabled till the errors are fixed.
  7. If you do not already have a Github instance, click 'Authenticate to Github'.
  8. You will be directed to Cloud Elements UI to create a Github element instance. 
  9. On the UI, fill all the required fields, OAuth API key, and OAuth API Secret.  Click 'Create Instance'. 
  10. Your instance is created with the tag "Community-Instance" added to it and will be used whenever you use the export functionality in the future.
  11. Once you have an instance, you're directed back to the Publish tab and it appears as shown below, with a check marked below Authenticate.
  12. Click on 'Publish' to create a pull request in the community to publish your element.
  13. You will see a screen, as shown below, once your pull request has been created.
  14. The status of your pull request will be notified to you via Github emails.