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.

Sign up for GitHub

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

Jump to bottom

The link to the manual from the readme doesn't work on GitHub #118

Closed
rptb1 opened this issue Jan 16, 2023 · 1 comment · Fixed by #141
Closed

The link to the manual from the readme doesn't work on GitHub #118

rptb1 opened this issue Jan 16, 2023 · 1 comment · Fixed by #141
Labels
documentation essential Will cause failure to meet customer requirements. Assign resources. git-migration Project migration from Ravenbrook internal Perforce infrastructure to public git repo

Comments

@rptb1
Copy link
Member

rptb1 commented Jan 16, 2023 •
edited
Loading

This link

mps/readme.txt

Lines 62 to 63 in 2ef000a

Then, to program and integrate the MPS you'll definitely need to read
the `manual <manual/html/index.html>`_.
works in the context of the Ravenbrook MPS site because the manual is built there. But on GitHub the manual is only in source form.

It's not good exhorting people to read the manual when the link is bust!

We probably need to build and publish the manual automatically somewhere else.

We should look at how some other projects do it.

See also #98 (comment)
@rptb1 rptb1 added documentation git-migration Project migration from Ravenbrook internal Perforce infrastructure to public git repo essential Will cause failure to meet customer requirements. Assign resources. labels Jan 16, 2023
@rptb1 rptb1 added this to the Perforce Divorce milestone Jan 16, 2023
@rptb1
Copy link
Member Author

rptb1 commented Jan 25, 2023 •
edited
Loading

When we decide on a canonical location for the built manual, we should be sure to search the tree for links and update them. There may be links to https://www.ravenbrook.com/project/mps/master/manual/html/ (or versions) lurking.

@rptb1 rptb1 mentioned this issue Feb 2, 2023
Merged
@rptb1 rptb1 removed this from the Perforce Divorce milestone Mar 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation essential Will cause failure to meet customer requirements. Assign resources. git-migration Project migration from Ravenbrook internal Perforce infrastructure to public git repo
Projects
Migrate the MPS from Perforce to Git
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Configuring Read the Docs to publish the MPS manual Ravenbrook/mps
1 participant
@rptb1