[FR]: Add a page in documentation website to explain the behavior of each command about obsidian-github-publisher HOT 10 CLOSED

So, I renamed :

• Share active file ->Upload single current active note
• Upload all shared notes ->Upload multiple notes
• Upload new shared notes -> Upload unpublished notes
• Upload all edited notes since last upload -> Refresh published notes
• Upload all new and edited notes since last upload → Refresh published and upload new notes
• Remove unshared and deleted file in repository → Purge unshared and deleted files
• Check validity of this repository → Test the connection to the configured repository

So there are :

• 3 Upload commands
• 2 Refresh commands
• 1 purge
• 1 testing

from obsidian-github-publisher.

Hello, the file is here : https://github.com/ObsidianPublisher/obsidian-github-publisher/blob/master/docs/en/COMMANDS.md

from obsidian-github-publisher.

Just have more experience with the commands of plugin Github Publisher. Based on my daily usage where I just write notes in Obsidian, then open Command Palette to sync all changes to repo. In order to further reduce the ambiguity, what do you think if the plugin would have only 3 commands, as follows?

1. Github Publisher: Publish single currently active note
   • Behavior: publish all notes which have the key share: true in their frontmatter
2. Github Publisher: Sync published notes to remote repository
   • Behavior: publish all notes which have the key share: true in their frontmatter AND (were not published since last upload OR were recently modified since last upload OR were newly created)
   • This command is expected to replace all these 3 commands below:
     • Github Publisher: Upload all shared notes
     • Github Publisher: Upload all edited notes since last upload
     • Github Publisher: Upload all new and edited notes since last upload
3. Github Publisher: Check validity of this repository
   • Behavior: check and display the result whether there is a valid connection between the plugin and its attached repository

from obsidian-github-publisher.

To be honest, I'm not a fan. I think there is some moment where you need one of the three.

from obsidian-github-publisher.

So, I renamed :

• Share active file ->Upload single current active note
• Upload all shared notes ->Upload multiple notes
• Upload new shared notes -> Upload unpublished notes
• Upload all edited notes since last upload -> Refresh published notes
• Upload all new and edited notes since last upload → Refresh published and upload new notes
• Remove unshared and deleted file in repository → Purge unshared and deleted files
• Check validity of this repository → Test the connection to the configured repository

So there are :

• 3 Upload commands
• 2 Refresh commands
• 1 purge
• 1 testing

Awesome. It sounds neat and concise.

But what is the difference between unshared in the Purge unshared and deleted files and unpublished in the Upload unpublished notes command?

from obsidian-github-publisher.

Unshared : They has been shared at some point, but it's stopped now (you change the key from true to false)

I changed unshared to depublished for more accurate description

from obsidian-github-publisher.

Hello, the file is here : https://github.com/ObsidianPublisher/obsidian-github-publisher/blob/master/docs/en/COMMANDS.md

Thanks for updating the docs.

I'm curious to learn why do you have to maintain the documentation for Github Publisher plugin in two separate repo? What's the reason for the difference between docs folder inside plugin repo and obsidian-mkdocs-publisher-docs?

from obsidian-github-publisher.

Because :

• I love complicated things (no, it's a joke!)
• There is too much files
• Mkdocs doesn't like monorepo

There is no difference between the file in docs/ and the docs repository. In fact, the docs repository is sync with the plugin repo, so when I do a push, the file are sync. It's pretty convenient, and it's is used to sync update for the two template for example.

The docs repo is published on netlify, but for the moment, there are a bug on mkdocs building. But the files are present and can be read on github.

I also put the file in the docs/ folder in Publisher because sometimes, people doesn't go directly on the big documentation and check first the docs in the plugin directly.

from obsidian-github-publisher.

aha, I see. Thanks for sharing your experience.

I've lurked again your repo to learn how to do the sync between repos, and found the sync_file.yml and its workflow

from obsidian-github-publisher.

Hello, the file is here : https://github.com/ObsidianPublisher/obsidian-github-publisher/blob/master/docs/en/COMMANDS.md

This link is 404 error now.

from obsidian-github-publisher.