Use local install version of DocFx

Details

We have included DocFx within our project, but we should be using the system's install of DocFx.

Sitemap and robots.txt

A sitemap and robots.txt need to be included.

Details

Sitemap

• A sitemap file will help with search engines crawling VoltProjects
  • DocFX v3 currently doesn't generate one, so we probs need to add that our selves.
• Index sitemap should link to each project's sitemap (If it has one, display a warning if it doesn't)

robots.txt

• robots.txt will tell search engines what pages to crawl.

Social Media Links

Add social media links to the footer, as well as to the developer section.

Details

Icon package will need to be used for the social media icons. Bootstrap Icons will most likely be used.

This issue tracks what needs to be done in VP 2.0.

(I been very bad and haven't included everything that has been done to VP 2.0 in this issue, since the scope has changed so much, and only now has been pretty much set.)

Builder

• Manage Git Repos
• Execute Pre-Build Commands
• Pre-Build Commands Order
• Description Extraction
• Assets Handling
• Improve upsert commands generation
• Check repo Git hashes

Server/Client

• Git Repo BTN in top right corner
• Open Current Doc in Git
• Better redirections
• Better Error Page
• Breadcrumbs
• Sitemap.xml
• Caching of Project Menu and TOCs
• FiraCode Monospace Font (I like it)

Database

• Pre-Build Commands Order
• Breadcrumbs
• Use more 'postgres' naming style

Only re-build if a new tag version is out

Details

We only want to build a project's site again if a new tag version is available

Use Serilog

Details

We need to log shit with Serilog.

Setup CI

Details

We need to configure GitHub actions to build the projects on push/PRs.

Project information

For each project VoltProject has, display some information

Details

Where each project is displayed, show the project's motto under the title.

Update Only Using Tags

Details

Use a project's repo tags.

Page Storage Items Generalization

Project pages currently support automatically uploading images as an external item and changing the img URL to the public URL of the storage item.

Support for other file types (such as JS) on <script> need to be added.

Stuff that will hopefully be done for 2.1.

Builder

• Support for docfx 2.0
• Tracing
• Pages track what pages are using what storage items
• Support for "External Items"
• Current page's git link

Server

• TOC Improvements
• Re-redirects for "External Items"
• Metabar
• Open current page in git
• (Possibly) Share page button

Database

• DB timestamps
• upsert_project_pages does not update all properties on update

Currently, project filtering is case-sensitive. If a user visits https://projects.voltstro.dev/UnityWebBrowser all is good, the project page will load, but if a user visits https://projects.voltstro.dev/unitywebbrowser, VoltProjects will come back with a 404 error.

This is happening because the unique name column is what is used for getting what project a page belongs to. The name column is also currently used for display reasons.

Normally, to compare strings Case-Insensitive, you use .Equals(comparing, StringComparison.InvariantCultureIgnoreCase), but with EF, that does not work, as we need to use Collations.

• Create new "display_name" column. UI will use this for displaying (as well as short_name on small screens).
• Add a non-deterministic collation and apply it the name column, and project_version.latest See https://www.npgsql.org/efcore/misc/collations-and-case-sensitivity.html?tabs=data-annotations

MkDocs Support

Support for MkDocs should be added. Currently, Pootis-Bot V1 docs use MKDocs, and VP doesn't support it as a builder.

Issues

It appears MkDocs doesn't have any per page JSON "models" (like docfx), it does however output a site/search/search_index.json file, which contains each page and their content, per sub-heading. The output content is also sometimes not complete, like with Pootis-Bot's custom download page.

It would be handy if each page outputted a single json file, with it's details. MkDocs does support custom plugins, perhaps a custom one could be made?

Ascii Logo Art

Display an ascii logo on start. Very important.

Details

Display "VoltProjects" in ascii art form in the logs/console when the server starts.

This is so VoltProjects is consistent with the rest of my projects. We are doing this because we can :-)

404 Error Page

On a 404 error, display an error page.

Details

When a 404 error occures, display an 404 error page, with something like "IDK what that file is".

If it is an unknown project site, maybe display an "Unknown project site".

Docs Search

The ability to search across doc pages. Currently you can only search across articles via the TOC's search, which searches across the current TOC page titles on the client side.

We want the ability to search docs, both via it's title and content. Postgres has good full text searching, which also handles our content field holding HTML content very well. It also means not running/using an external service for search.
Text-Search types in postgres need a regconfig value, containing a configuration for a language. While VP doesn't have proper support for multi-language, we still want to keep project_pages multi-lang, to not make future life harder. The index that is needed for good performance TS in postgres can pull it's config from a column. We can't use subqueries in indexes, so a column will need to be added to project_pages.

Tasks

• Add language_config of type regconfig to project_pages. This value shall be provided by a new column in language called configuration.
• Add new index to project_pages for search vector

  CREATE INDEX ix_project_page_search_vector ON public.project_page USING gin (to_tsvector(language_config, content));

• UI - To be designed still

Home/About Pages

Details

Home Page

Home page should list all projects that VoltProjects has.

About Page

Give some detail into what VoltProjects is.

Issue to track upgrading VoltProjects to .NET 8.

No build issues on .NET 8 (as expected).

Packages

Main critical packages that also need .NET 8 releases:

• Microsoft.EntityFrameworkCore
  • Related buddies (Tools, etc)
• Npgsql.EntityFrameworkCore.PostgreSQL (Release candidate for .NET 8 is out)
• EFCore.NamingConventions (Release candidate for .NET 8 is out)
• DistributedLock.Postgres

Notes

• DistributedLock.Postgres does not work with .NET 8 version of Npgsql.EntityFrameworkCore.PostgreSQL due to breaking changes in Npgsql. Issue was fixed in DistributedLock.Postgres 1.0.5
• Npgsql.EntityFrameworkCore.PostgreSQL needs EnableDynamicJson() to be called now, to allow JSON. To support this, AddNpgsqlDataSource was added. This for whatever reason broke dbContext.Database.GetConnectionString();, which now returns everything except the password key now. To fix this issue, dbContext.Database.GetDbConnection(); was used, and the connection was passed onto PostgresDistributedLock instead.

Confiure Sentry using an enviromental variable

NOTE: We scraped using Sentry.

Details

Configure Sentry using the enviromental variable SENTRY_DSN.