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

There should be general LAPIS docs, without database specific fields #928

Closed
corneliusroemer opened this issue Sep 2, 2024 · 2 comments · Fixed by #1006, #1009 or loculus-project/loculus#3361
Closed

There should be general LAPIS docs, without database specific fields #928

corneliusroemer opened this issue Sep 2, 2024 · 2 comments · Fixed by #1006, #1009 or loculus-project/loculus#3361
Assignees
@fengelniederhammer

Comments

@corneliusroemer
Copy link
Contributor

It appears every single LAPIS instance should set up its own docs instance? I think this is suboptimal: most content will be duplicated. It'd be nice if the invariant content was on a central LAPIS url, so that not every LAPIS user needs to have mostly identical content out there.

One can then just Google something and use the official docs (for invariant content)

Follow up from what I learned in #924
@corneliusroemer corneliusroemer mentioned this issue Oct 21, 2024
Closed
@fhennig
Copy link

fhennig commented Oct 22, 2024

I agree. Additionally this would potentially clarify which parts are invariant and which aren't, which would also be nice.

fengelniederhammer added a commit that referenced this issue Oct 23, 2024
@fengelniederhammer
docs(root): link to docs of the open covid instance in README
38a469d 
Refs: #928
fengelniederhammer added a commit that referenced this issue Oct 23, 2024
@fengelniederhammer
docs(root): link to docs of the open covid instance in README
c8037a5 
Refs: #928
@fengelniederhammer fengelniederhammer mentioned this issue Oct 23, 2024
Merged
1 task
@fengelniederhammer
Copy link
Contributor

I added links to the README in #998.

What remains to be done: Mark the parts in the docs that are dynamically generated for the specific config.

fengelniederhammer added a commit that referenced this issue Oct 23, 2024
@fengelniederhammer
docs(root): link to docs of the open covid instance in README
71dec61 
Refs: #928
@fengelniederhammer fengelniederhammer self-assigned this Nov 11, 2024
fengelniederhammer added a commit that referenced this issue Nov 11, 2024
@fengelniederhammer
feat(lapis-docs): mark sections of the docs that are generated from t…
e780c60 
…he config

This also fixes pango lineage docs (we can't be sure anymore which lineage fields are pango lineages).
Also, all sections are now always available.

Resolves: #928
@fengelniederhammer fengelniederhammer mentioned this issue Nov 11, 2024
Merged
2 tasks
fengelniederhammer added a commit that referenced this issue Nov 14, 2024
@fengelniederhammer
feat(lapis-docs): mark sections of the docs that are generated from t…
f8da4de 
…he config

This also fixes pango lineage docs (we can't be sure anymore which lineage fields are pango lineages).
Also, all sections are now always available.

Resolves: #928
@github-actions github-actions bot mentioned this issue Nov 14, 2024
Merged
fengelniederhammer added a commit to loculus-project/loculus that referenced this issue Dec 4, 2024
@fengelniederhammer
chore(kubernetes): upgrade to LAPIS 0.3.10
338652c 
## [0.3.10](GenSpectrum/LAPIS@v0.3.9...v0.3.10) (2024-12-03)

### Features

* **lapis:** add LAPIS version to info response ([#1019](GenSpectrum/LAPIS#1019)) ([7d8d713](GenSpectrum/LAPIS@7d8d713))

## [0.3.9](GenSpectrum/LAPIS@v0.3.8...v0.3.9) (2024-11-14)

### Features

* **lapis-docs:** mark sections of the docs that are generated from the config ([b2009eb](GenSpectrum/LAPIS@b2009eb)), closes [#928](GenSpectrum/LAPIS#928)
@fengelniederhammer fengelniederhammer mentioned this issue Dec 4, 2024
Merged
1 task
fengelniederhammer added a commit to loculus-project/loculus that referenced this issue Dec 4, 2024
@fengelniederhammer
chore(kubernetes): upgrade to LAPIS 0.3.10 (#3361)
b576465 
## [0.3.10](GenSpectrum/LAPIS@v0.3.9...v0.3.10) (2024-12-03)

### Features

* **lapis:** add LAPIS version to info response ([#1019](GenSpectrum/LAPIS#1019)) ([7d8d713](GenSpectrum/LAPIS@7d8d713))

## [0.3.9](GenSpectrum/LAPIS@v0.3.8...v0.3.9) (2024-11-14)

### Features

* **lapis-docs:** mark sections of the docs that are generated from the config ([b2009eb](GenSpectrum/LAPIS@b2009eb)), closes [#928](GenSpectrum/LAPIS#928)
@github-actions github-actions bot mentioned this issue Jan 22, 2025
Closed
@github-actions github-actions bot mentioned this issue Feb 10, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fengelniederhammer fengelniederhammer

Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@fhennig @corneliusroemer @fengelniederhammer