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

Restore downloads section #28

Open
garfieldnate opened this issue Jun 28, 2024 · 1 comment
Open

Restore downloads section #28

garfieldnate opened this issue Jun 28, 2024 · 1 comment

Comments

@garfieldnate
Copy link
Collaborator

We have dozens of agents, tools, etc. that were downloadable from the old website. The last couple of Soar releases have included all of them in the zip, which I don't think is idea. All of the explanations, author names, etc. are gone.

@garfieldnate garfieldnate changed the title Restored downloads section Restore downloads section Jun 29, 2024
garfieldnate added a commit that referenced this issue Jun 29, 2024
garfieldnate added a commit that referenced this issue Jun 30, 2024
There are a *lot* of download pages, so we'll start with the headers, structure,
and a sort of template we can use for the others.

See #28.
garfieldnate added a commit that referenced this issue Jun 30, 2024
Figuring out the plugin system and everything so that we can generate the
download pages from structured data sounds great but a bit time-consuming;
having a script to generate all of the boilerplate is a good middle-road for
now.

The data class I ended up *not* adding here is the following (rough draft):

```python3
from dataclasses import dataclass
from typing import List

@DataClass
class Download:
    page_title: str
    description: str
    download_links: List[str]
    soar_capabilities: List[str]|None = None
    external_environment: str|None = None
    default_rules: str|None = None
    associated_publications: List[str]|None = None
    developers: List[str]
    soar_versions: List[str]
    project_type: str|None = None

ALL_DOWNLOADS = {
    "agents": [],
    "agent_dev_tools": [],
    "domains": [],
    "examples_and_unsupported": [],
}
```

See #28.
garfieldnate added a commit that referenced this issue Jun 30, 2024
@garfieldnate
Copy link
Collaborator Author

If we need download links to match their previous URLs, we can use https://github.com/mkdocs/mkdocs-redirects.

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

No branches or pull requests

1 participant