Plugin Upload

Learn how to upload and publish your plugins to the ElasticView Plugin Marketplace.

Before You Upload

Pre-Upload Checklist

Ensure your plugin is ready:

• [ ] Plugin is fully tested and functional
• [ ] Documentation is complete (README, installation guide)
• [ ] Plugin manifest (plugin.yaml) is properly configured
• [ ] Screenshots are high-quality and representative
• [ ] Code is clean and follows best practices
• [ ] Security review has been completed
• [ ] License file is included

Required Files

Your plugin package must include:

• plugin.yaml: Plugin manifest with metadata
• README.md: Comprehensive documentation
• LICENSE: Software license file
• Binary files: Compiled plugin executable
• Assets: Icons, screenshots, and other media
• Frontend: Built web interface (if applicable)

Upload Process

Step 1: Access Upload Page

1. Login to Developer Portal

   • Go to Developer Portal
   • Sign in with your developer account

2. Navigate to Upload

   • Click "Upload Plugin" button
   • Or go to Plugin Management → "New Plugin"

Step 2: Plugin Package Upload

1. Select Plugin File

   • Click "Choose File" or drag-and-drop
   • Select your plugin package (.zip file)
   • Maximum file size: 100MB (500MB for premium accounts)

2. Upload Progress

   • Monitor upload progress bar
   • Wait for upload completion
   • Don't close browser during upload

3. Package Validation

   • Automatic validation of package structure
   • Check for required files
   • Verify manifest format

Step 3: Plugin Information

Fill out plugin details:

Basic Information

• Plugin Name: Display name (must be unique)
• Short Description: Brief one-line description
• Detailed Description: Comprehensive feature description
• Category: Select primary category
• Tags: Add relevant keywords (max 10)

Version Information

• Version Number: Semantic versioning (e.g., 1.0.0)
• Release Notes: What's new in this version
• Compatibility: Supported ElasticView versions
• Dependencies: Required external components

Developer Information

• Author Name: Your name or organization
• Contact Email: Support email address
• Homepage: Plugin website or repository URL
• Support URL: Where users can get help

Step 4: Media Upload

Add visual content:

Plugin Icon

• Format: PNG or JPG
• Size: 256x256 pixels (recommended)
• Background: Transparent or solid color
• Style: Professional and recognizable

Screenshots

• Quantity: 1-5 screenshots
• Format: PNG or JPG
• Size: 1280x720 pixels (recommended)
• Content: Show key features and interface

Optional Media

• Banner Image: Promotional banner for featured listings
• Video Demo: YouTube or Vimeo link to demonstration

Step 5: Pricing and Distribution

Pricing Model

• Free: No cost to users
• Paid: One-time purchase
• Freemium: Free with premium features
• Subscription: Recurring payment

Distribution Settings

• Visibility: Public, unlisted, or private
• Geographic Restrictions: Limit by country/region
• User Restrictions: Limit to specific user groups
• Beta Release: Mark as beta version

Step 6: Review and Submit

1. Preview Plugin Listing

   • Review how your plugin will appear
   • Check all information for accuracy
   • Test download link functionality

2. Terms and Conditions

   • Read and accept marketplace terms
   • Confirm copyright ownership
   • Agree to content policies

3. Submit for Review

   • Click "Submit for Review"
   • Plugin enters review queue
   • Receive confirmation email

Review Process

Automated Review

Initial automated checks:

1. Security Scan

   • Malware detection
   • Vulnerability assessment
   • Code analysis

2. Quality Checks

   • Package integrity
   • File structure validation
   • Manifest verification

3. Performance Testing

   • Resource usage analysis
   • Load time measurement
   • Compatibility testing

Manual Review

Human reviewers check:

1. Functionality

   • Plugin works as described
   • Features match documentation
   • No critical bugs

2. User Experience

   • Interface is intuitive
   • Installation is smooth
   • Documentation is clear

3. Policy Compliance

   • Content guidelines adherence
   • No prohibited content
   • Appropriate categorization

Review Timeline

• Standard Review: 2-5 business days
• Complex Plugins: Up to 10 business days
• Priority Review: 24 hours (premium accounts)
• Resubmission: 1-3 business days

Review Results

Approval

If your plugin is approved:

1. Publication Notification

   • Email confirmation sent
   • Plugin goes live in marketplace
   • Download statistics begin tracking

2. Post-Publication

   • Monitor user feedback
   • Respond to reviews
   • Track download metrics

Rejection

If your plugin is rejected:

1. Rejection Notice

   • Detailed explanation of issues
   • List of required fixes
   • Resubmission instructions

2. Common Rejection Reasons

   • Security vulnerabilities
   • Poor documentation
   • Functionality issues
   • Policy violations
   • Incomplete package

3. Resubmission Process

   • Fix identified issues
   • Update plugin package
   • Resubmit for review

Update Existing Plugins

Version Updates

To update an existing plugin:

1. Prepare New Version

   • Increment version number
   • Update changelog
   • Test thoroughly

2. Upload Process

   • Go to Plugin Management
   • Select existing plugin
   • Click "Upload New Version"
   • Follow upload process

3. Update Information

   • Modify description if needed
   • Add new screenshots
   • Update compatibility information

Metadata Updates

You can update without new version:

• Plugin description
• Screenshots and media
• Tags and categories
• Pricing information
• Distribution settings

File Requirements

Package Structure

plugin-package.zip
├── plugin.yaml          # Plugin manifest
├── README.md            # Documentation
├── LICENSE              # License file
├── plugin-binary        # Executable
├── assets/              # Media files
│   ├── icon.png
│   ├── screenshot1.png
│   └── screenshot2.png
└── frontend/            # Web interface
    └── dist/            # Built files

Plugin Manifest (plugin.yaml)

name: "my-plugin"
version: "1.0.0"
description: "Plugin description"
author: "Your Name"
email: "your@email.com"
homepage: "https://github.com/yourname/plugin"
category: "visualization"
tags: ["charts", "analytics"]
license: "MIT"
min_ev_version: "1.0.0"

File Size Limits

• Free Account: 50MB maximum
• Premium Account: 500MB maximum
• Individual Files: No specific limit
• Total Package: Must fit within account limit

Best Practices

Package Optimization

• Compress assets to reduce file size
• Remove development files (source maps, tests)
• Include only necessary dependencies
• Use efficient file formats (WebP for images)

Documentation Quality

• Clear installation instructions
• Comprehensive feature descriptions
• Configuration examples
• Troubleshooting guide
• API documentation (if applicable)

Visual Assets

• Professional screenshots showing key features
• Consistent visual style across all assets
• High-resolution images for clarity
• Descriptive captions for screenshots

Version Management

• Semantic versioning (major.minor.patch)
• Detailed changelogs for each version
• Backward compatibility when possible
• Migration guides for breaking changes

Troubleshooting

Upload Issues

1. File Too Large

   • Compress assets
   • Remove unnecessary files
   • Upgrade to premium account

2. Invalid Package Format

   • Check file structure
   • Verify manifest syntax
   • Include all required files

3. Upload Timeout

   • Check internet connection
   • Try uploading during off-peak hours
   • Split large files if possible

Review Issues

1. Security Concerns

   • Review code for vulnerabilities
   • Update dependencies
   • Follow security best practices

2. Functionality Problems

   • Test in clean environment
   • Verify all features work
   • Check error handling

3. Documentation Issues

   • Improve clarity and completeness
   • Add missing sections
   • Include examples and screenshots

Support

Getting Help

1. Documentation

   • Read upload guidelines
   • Check FAQ section
   • Review best practices

2. Contact Support

   • Email: upload-support@elastic-view.cn
   • Include plugin name and issue description
   • Attach relevant files or screenshots

3. Community Forum

   • Ask questions
   • Share experiences
   • Get advice from other developers

Next Steps

• Plugin Management - Manage your uploaded plugins
• Version Management - Handle plugin versions
• Account Management - Manage your developer account
• Plugin Development - Improve your development skills