obsidian-releases icon indicating copy to clipboard operation
obsidian-releases copied to clipboard

Add plugin: KV Store

Open mickeydarrenlau opened this issue 1 year ago • 8 comments

I am submitting a new Community Plugin

Repo URL

Link to my plugin: https://github.com/Darren-project/obsidian-kv

Release Checklist

  • [X] I have tested the plugin on
    • [X] Windows
    • [ ] macOS
    • [ ] Linux
    • [X] Android (if applicable)
    • [ ] iOS (if applicable)
  • [X] My GitHub release contains all required files
    • [X] main.js
    • [X] manifest.json
    • [X] styles.css (optional)
  • [X] GitHub release name matches the exact version number specified in my manifest.json (Note: Use the exact version number, don't include a prefix v)
  • [X] The id in my manifest.json matches the id in the community-plugins.json file.
  • [X] My README.md describes the plugin's purpose and provides clear usage instructions.
  • [X] I have read the developer policies at https://docs.obsidian.md/Developer+policies, and have assessed my plugins's adherence to these policies.
  • [X] I have read the tips in https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines and have self-reviewed my plugin to avoid these common pitfalls.
  • [X] I have added a license in the LICENSE file.
  • [X] My project respects and is compatible with the original license of any code from other plugins that I'm using. I have given proper attribution to these other projects in my README.md.

mickeydarrenlau avatar Feb 01 '24 09:02 mickeydarrenlau

Hello!

I found the following issues in your plugin submission

Errors:

:x: Please don't use the word obsidian in the plugin ID. The ID is used for your plugin's folder so keeping it short and simple avoids clutter and helps with sorting. :x: Please don't use the word Obsidian at the start of your plugin name since it's redundant and makes it harder to sort the plugin list. :x: Unable to find a release with the tag 1.0.0. Make sure that the version in your manifest.json file in your repo points to the correct Github Release.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

github-actions[bot] avatar Feb 01 '24 09:02 github-actions[bot]

Hello!

I found the following issues in your plugin submission

Errors:

:x: Please don't use the word obsidian in the plugin ID. The ID is used for your plugin's folder so keeping it short and simple avoids clutter and helps with sorting. :x: Please don't use the word Obsidian at the start of your plugin name since it's redundant and makes it harder to sort the plugin list. :x: Unable to find a release with the tag 1.0.2. Make sure that the version in your manifest.json file in your repo points to the correct Github Release.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

github-actions[bot] avatar Feb 01 '24 09:02 github-actions[bot]

Hello!

I found the following issues in your plugin submission

Errors:

:x: Please don't use the word obsidian in the plugin ID. The ID is used for your plugin's folder so keeping it short and simple avoids clutter and helps with sorting. :x: Please don't use the word Obsidian at the start of your plugin name since it's redundant and makes it harder to sort the plugin list. :x: Plugin ID mismatch, the ID in this PR (obsidian-kv) is not the same as the one in your repo (kv-store). If you just changed your plugin ID, remember to change it in the manifest.json in your repo and your latest GitHub release. :x: Plugin name mismatch, the name in this PR (Obsidian KV) is not the same as the one in your repo (KV Store). If you just changed your plugin name, remember to change it in the manifest.json in your repo and your latest GitHub release.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

github-actions[bot] avatar Feb 01 '24 09:02 github-actions[bot]

Hello!

I found the following issues in your plugin submission

Errors:

:x: Please don't use the word obsidian in the plugin ID. The ID is used for your plugin's folder so keeping it short and simple avoids clutter and helps with sorting. :x: Please don't use the word Obsidian at the start of your plugin name since it's redundant and makes it harder to sort the plugin list. :x: Plugin ID mismatch, the ID in this PR (obsidian-kv) is not the same as the one in your repo (kv-store). If you just changed your plugin ID, remember to change it in the manifest.json in your repo and your latest GitHub release. :x: Plugin name mismatch, the name in this PR (Obsidian KV) is not the same as the one in your repo (KV Store). If you just changed your plugin name, remember to change it in the manifest.json in your repo and your latest GitHub release.


This check was done automatically. Do NOT open a new PR for re-validation. Instead, to trigger this check again, make a change to your PR and wait a few minutes, or close and re-open it.

github-actions[bot] avatar Feb 01 '24 09:02 github-actions[bot]

Required

"description": "Adds a key-value store to Obsidian. Use it to store and retrieve key-value pairs in your vault.", Avoid including sentences like "Adds ... to Obsidian" in your description, it should be self-evident that this is a plugin for Obsidian. We have published a guide for plugin descriptions to follow here: https://docs.obsidian.md/Plugins/Releasing/Submission+requirements+for+plugins#Keep+plugin+descriptions+short+and+simple.

"fundingUrl": "", Omit this if you don't have one.

// Remember to rename these classes and interfaces! Remove this.

onConfigFileChange(): void { Remove this, it will only cause issues having this here.

There is no documentation what the Server URL is used for, please add some.


Optional

SharedStuff Use a better class name

joethei avatar Feb 12 '24 09:02 joethei

onconfig - fixed comment - fixed

mickeydarrenlau avatar Feb 16 '24 04:02 mickeydarrenlau

Your documentation is still lacking, like how would one setup such a server?

joethei avatar Feb 19 '24 14:02 joethei

Your documentation is still lacking, like how would one setup such a server?

It need a nodejs server should I just bundle it and give user the zip via a button or make a git repo for it

mickeydarrenlau avatar Feb 23 '24 06:02 mickeydarrenlau

@joethei

mickeydarrenlau avatar Mar 01 '24 06:03 mickeydarrenlau

Create a repo for it add some instructions how to set it up.

joethei avatar Mar 01 '24 18:03 joethei

@joethei Done

mickeydarrenlau avatar Mar 02 '24 12:03 mickeydarrenlau

Hi there, as this PR has not seen any activity in the last 30 days, it will be closed in 15 days unless there are any updates.

github-actions[bot] avatar Apr 02 '24 07:04 github-actions[bot]

hi

mickeydarrenlau avatar Apr 02 '24 11:04 mickeydarrenlau

How does one boot up the server? How does one install it in the first place? The instructions are still severely lacking

joethei avatar Apr 02 '24 16:04 joethei

@joethei Done https://github.com/Darren-project/obsidian-kv-wss/tree/main

mickeydarrenlau avatar Apr 05 '24 23:04 mickeydarrenlau