Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make automated edits of Author/People pages less error-prone #348

Open
claremacrae opened this issue Mar 13, 2022 · 5 comments
Open

Make automated edits of Author/People pages less error-prone #348

claremacrae opened this issue Mar 13, 2022 · 5 comments
Assignees

Comments

@claremacrae
Copy link
Contributor

claremacrae commented Mar 13, 2022

When update_releases.py is used to update existing author, plugin and theme pages there is a tedious set of manual checks and reversions to be done...

These reversions are not documented, which limits the number of people who can do this step to essentially @claremacrae and @argenos.

This issue is to record the steps needed to remove as many of those manual edits as possible.

See also #166 (Make manual edits of Author/People pages less error-prone) which is about things like streamlining the formatting of links in the author template, to make adding things like sponsorship links easier.

For the background to this, see the Content: People page.

@claremacrae
Copy link
Contributor Author

The following are the bits of People pages that get automatically updated content:

  1. Sometimes the website e.g.
- Website: <https://github.com/Signynt> ^website
  1. Lists of plugins and themes:
%% Begin Hub: Released contributions %%
...
%% End Hub: Released contributions %%
  1. Different spellings of the author name in different manifest files by the same author

@claremacrae
Copy link
Contributor Author

Things that interfere with the updating of the above information:

  1. Flickering, random changes of the author URL, due to repo URLs being used as the authorURL in the manifest, and the author publishing new plugins
  2. Plugins which have been removed from community releases being still listed in the author's Plugins list, such as obsidian-footnotes and pdf-to-markdown-plugin by akaalias
  3. Plugins having more than one author
  4. Customisations, such as "buy me a coffee" links and "twitter account" links, that are overwritten with text from the author template each time a full update of the hub content is done
    • Suggestion: Divide up author.md.jinja in to sections, as has been done for themes and plugins - so that the section delimited by %% Begin Hub: Released contributions %% and %% End Hub: Released contributions %% can be over-written, without interfering with the rest of the file's potentially manually updated content.
  5. Full path being needed to disambiguate links between an author and theme whose files have the same name - see Script the special case of hipstersmoothie and other duplicate file names #143

@claremacrae
Copy link
Contributor Author

A not-yet-documented component of this is changing update_releases.py --overwrite so that it only selectively updates only the parts of author notes that contain no human edits, such as the lists of published plugins and themes.

@claremacrae claremacrae self-assigned this Mar 15, 2022
claremacrae added a commit that referenced this issue Mar 15, 2022
claremacrae added a commit that referenced this issue Mar 15, 2022
This change only applies to files created from 'T - Author.md' template.

See #348
claremacrae added a commit that referenced this issue Mar 15, 2022
This change only applies to files created from 'T - Author.md' template.

See #348
claremacrae added a commit that referenced this issue Mar 15, 2022
@argenos
Copy link
Contributor

argenos commented Apr 27, 2022

From our pairing session on saturday:

  • On websites, ignore any that begin with github.com (duplicated info already in the template) or obsidian.md (failed to update manifest.json)
  • add a check to verify plugin names are not obsidian (incorrectly or missing update to manifest.json from template)
  • Make discord handle an alias instead of part of the note (will make it easier to find related notes or unlinked mentions from the roundup)
  • Group author information according to the way it's added: manual (publish) and what is added by our scripts (github link, website if present in manifest.json)

@argenos
Copy link
Contributor

argenos commented Apr 27, 2022

Related: #217

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants