Skip to content

[docs] Remove deprecated make install-dev from installation guide #3102

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

Open
wants to merge 44 commits into
base: dev
Choose a base branch
from

Conversation

Xiaoha-cloud
Copy link

Description

  • This PR removes the outdated and now removed make install-dev command from the documentation.
  • The make install-dev command was previously used to install developer dependencies and setup Augur in editable mode, but this functionality is now handled by make install and optionally pip install -e .[dev].

This PR fixes #3050

Notes for Reviewers

  • Changes were made in:
    • docs/source/development-guide/installation.rst
    • docs/source/development-guide/make/installation.rst
  • make install-dev is no longer in the Makefile, and this resolves the confusion raised in the issue.

Signed commits

  • Yes, I signed my commits.

ABrain7710 and others added 30 commits March 8, 2025 14:08
Signed-off-by: Sean P. Goggins <[email protected]>
Signed-off-by: Sean P. Goggins <[email protected]>
Events fix for Augur instance anomalies (One instance with an issue. We think this fixes that, and provides a more performant index going forward).
it seems to be broken and not kept up to date with the docker compose file

Signed-off-by: Adrian Edwards <[email protected]>
Signed-off-by: Adrian Edwards <[email protected]>
Signed-off-by: Sean P. Goggins <[email protected]>
Signed-off-by: Sean P. Goggins <[email protected]>
Signed-off-by: Sean P. Goggins <[email protected]>
add flower section to the docker compose
log stderr in called process for facade commit count
Leave room on github api key rate limit
fixing install-dev command by removal
adjust path that scc gets copied to
Signed-off-by: Sean P. Goggins <[email protected]>
Marcel Beyer and others added 14 commits March 21, 2025 11:53
Signed-off-by: Marcel Beyer <[email protected]>
- Move from custom scripting to re-usable actions
- Add workflow_dispatch so build can be triggered manually

Signed-off-by: John Strunk <[email protected]>
Docker mac fix
- tested on OSX
- tested on Ubuntu 22.x
Signed-off-by: Sean P. Goggins <[email protected]>
[Docs] Corrected GitLab Public Access Token URL in Documentation
Fix failing CI when not tagging a docker image
@Xiaoha-cloud Xiaoha-cloud requested a review from sgoggins as a code owner April 2, 2025 17:26
@Xiaoha-cloud
Copy link
Author

Hi @sgoggins and @ABrain7710, I’ve opened this PR to resolve issue #3050.
It’s ready for review when you have time. Thank you!

🔧 What I’ve done:

  • Removed all outdated make install-dev references from the docs.
  • Replaced with updated guidance:
    • make install as the default
    • pip install -e .[dev] as optional for developer dependencies
  • Modified two files:
    • docs/source/development-guide/installation.rst
    • docs/source/development-guide/make/installation.rst

@Xiaoha-cloud Xiaoha-cloud changed the base branch from main to dev April 2, 2025 20:39
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

Successfully merging this pull request may close these issues.

Issue with the installation guide for Augur
8 participants