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

Implement external JSON-LD file #605

Merged
merged 1 commit into from
Feb 16, 2024
Merged

Implement external JSON-LD file #605

merged 1 commit into from
Feb 16, 2024

Conversation

tomschr
Copy link
Collaborator

@tomschr tomschr commented Jan 29, 2024

Situation

We need to change the way an external JSON file with a JSON-LD structure is created. This structure contains some important metadata.

Related

Docteam1249

@tomschr tomschr self-assigned this Jan 29, 2024
@tomschr tomschr marked this pull request as ready for review February 16, 2024 12:47
The structure is based on schema.org

Introduce new parameters:

* generate.json-ld.external (0=no, 1=yes)
  Should a JSON-LD structure stored?
* json-ld-use-individual-authors (0=no, 1=yes)
  Should the individual authors be used?
* json-ld.ext (default ".json)
  The default extension of the JSON file
* json-ld-date-timezone (default "T00:00+02:00)
  The default timezone for dates when no timezone is specified
* json-ld-fallback-author-name (default "SUSE Product & Solution
  Documentation Team")
  Default name of author when no <author> is specified
* json-ld-fallback-author-url (default: "https://documentation.suse.com")
  Default URL for an author, when no <author> is specified
* json-ld-fallback-author-type (default "Corporation")
  Default type of an author, when no <author> is specified
* json-ld-fallback-author-logo (default
  "https://www.suse.com/assets/img/suse-white-logo-green.svg")
  Default logo URL, when no <author> is specified
* json-ld-image-url (default $json-ld-fallback-author-logo)
  Default image URL for a TechArticle
* stitchfile (str, default ='')
  Absolute filename to the single stitch file that Docserv generates on startup
@tomschr tomschr merged commit 3adb372 into main Feb 16, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant