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

Rewrite "Using the TEI GitHub Repository" #720

Open
ebeshero opened this issue Dec 5, 2024 · 3 comments
Open

Rewrite "Using the TEI GitHub Repository" #720

ebeshero opened this issue Dec 5, 2024 · 3 comments
Assignees

Comments

@ebeshero
Copy link
Member

ebeshero commented Dec 5, 2024

Attempting to fix a dead link on the Stylesheets README (see #703 and #710) leads to an unhappy discovery: Our documentation about working locally with the Stylesheets is outdated.

I recommend that we rewrite the Using the TEI GitHub Repository page that now only exists on the old TEI website. Some of the information is useful, but much of it is out of date.

  • We should definitely remove the outdated info about working with the old Roma.
  • Maybe we can trim this to confine the advice to local installation requirements and how to work with the Makefile?
  • If we make a new version of this page, we should link it to our TCW 32: Testing and Building the TEI Guidelines, which provides guidance on the Docker environment.
@ebeshero
Copy link
Member Author

ebeshero commented Dec 5, 2024

Self-assigning to connect with #705

@martindholmes
Copy link
Contributor

It strikes me that we may have more than one distinct audience for this documentation. There are Council people, who can be expected to be more tech-savvy and who will have guidance and mentoring from existing members; they will need to run and debug stylesheets tests as well as just using the stylesheets. Then there are end-users, who are presumably either interested in doing more that is possible through TEI-Garage or perhaps need to work without regular access to it, and they'll need more user-friendly guidance but won't need to worry about the tests. There's also a distinction between documentation of how the stylesheets actually work (for maintainers) and documentation of how to use them. Should we be creating separate resources for these audiences and purposes?

@martindholmes
Copy link
Contributor

@ebeshero Where should this new set of instructions go? Options are:

  • A page on the TEI website
  • The README on the Stylesheets repo or the TEI repo
  • An instructions document inside the repo(s)
  • A section of the Guidelines (not appropriate, surely)

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

2 participants