Overview

This document will contain general information on data in this project.

General Note

This project is a work in progress. As such, most of the data in the website doesn't follow the document. Ideally, this will be fixed over time.

SQL

Relational data is stored in a local SQL database.

This data is converted into JSON so it can be handled by Blazor WASM.

Currently, Blazor WASM has a bug that prevents SQL from being used in production. Although, given SQL doesn't seem to provide much, aside from increased build times and load times, it might just be best to use the design principals of SQL, and it's interface, without using the actual technology in production.

The data is then loaded in by a Service, via it's load method.

// Using Component
protected override async Task OnInitializedAsync()
{
    await AgileService.Load();
}

// Loading Service
public async Task Load()
{
    if (isLoaded) return;
    AgileSprintModels =
        (await httpClient.GetFromJsonAsync<AgileSprintModel[]>("generated/AgileSprintModels.json")
         ?? Array.Empty<AgileSprintModel>()).ToList();
    AgileTaskModels =
        (await httpClient.GetFromJsonAsync<AgileTaskModel[]>("generated/AgileTaskModels.json")
         ?? Array.Empty<AgileTaskModel>()).ToList();
    SortSql();
    isLoaded = true;
    NotifyDataChanged();
}

We create a SortSql() method to handle adjusting the data to match what SQL would of given us.

private void SortSql()
{
    foreach (var agileTask in AgileTaskModels!)
    {
        if (agileTask.AgileSprintModelId != null)
        {
            SprintById(agileTask.AgileSprintModelId.Value)?.AgileTaskModels.Add(agileTask);
        }
    }
}

We could also create indexes, or whatever other functionality we lose by SQL not working in production.

Then it's only a matter of using said data.

@if (!agileService.IsLoaded())
{
    <LoadingComponent/>
}
else
{
    <LayoutMediumContentComponent>
        <WebsiteTitleComponent>Agile</WebsiteTitleComponent>
        <div class="agileViewContainer">
            @foreach (var sprint in agileService.AgileSprintModels!
                .OrderBy(e => e.EndDate).Reverse())
            {
                <details class="sprintDisplayContainer @sprint.GetSprintType().ToLower()"
                         open="@(sprint.GetSprintType() == SprintType.Current)">
                    <summary class="sprintSummary">
                        <div class="sprintTitle">@sprint.Name</div>

Localized Strings

Localized strings are handled in the Localizations.resx file.

Most text isn't using localized strings yet. And English is the only plan of support in the short term, and probably in the long term as well.

Markdown Files

Documents are currently handled in the SQL database. But ideally, they will be markdown documents instead, with links to GitHub.

Basically long term, this website will perhaps also act as a public wiki. Who knows? With GitHub as the public CMS.

So if Blazor WASM doesn't support some markdown generation that is not cumbersome, then the IGP_Convert tool will need to be extended to convert Markup files to files Blazor WASM can use.

And ideally, any generation systems we write will use any front-matter in the markdown documents.

Each of these pages will have one of those edit on github buttons.

3.3 KiB Raw Blame History

Overview

General Note

SQL

Localized Strings

Markdown Files

3.3 KiB

Raw Blame History