Skip to content

Commit 02627dd

Browse files
authored
Preparing for 2.7 by Updating README links (#2)
* Fixing Sphinx-related links that do not work with PyPI * Updating the version number for the initial release. * Fixing a broken link * Adding the version badge * Fixing a few duplicate links. * Updating the links with our new URLs * Adding in dependabot to help with dependency management.
1 parent ec3a83e commit 02627dd

File tree

4 files changed

+27
-10
lines changed

4 files changed

+27
-10
lines changed

.github/dependabot.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "pip" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "weekly"

README.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ FIREWHEEL
55
.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
66
:target: CODE_OF_CONDUCT.md
77

8+
.. image:: https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%7C%203.11%7C%203.12%7C%203.13-blue
9+
810
.. readme-inclusion-marker
911
1012
FIREWHEEL is an experiment orchestration tool that assists a user in building and controlling, repeatable experiments of distributed network systems at any scale.
@@ -21,11 +23,11 @@ Therefore, it is trivial to run hundreds of experiments and collect results on t
2123
Getting Started
2224
***************
2325

24-
* For a crash course on key FIREWHEEL concepts and on using FIREWHEEL please see our :ref:`quickstart-guide` guide.
25-
* To learn why experimentation may be the right tool to answer certain kinds of questions (and when it is probably the wrong tool) see :ref:`emulytics-introduction`.
26-
* An overview of FIREWHEEL including how FIREWHEEL can help a researcher implement high-quality emulation-based experiments, hardware requirements, software architecture, and known security security concerns is provided in :ref:`FIREWHEEL-introduction`.
27-
* An in-depth review of important FIREWHEEL concepts, is located in :ref:`FIREWHEEL-concepts`.
28-
* The CLI reference documentation can be found in :ref:`cli`.
26+
* For a crash course on key FIREWHEEL concepts and on using FIREWHEEL please see our `quickstart-guide <https://sandialabs.github.io/firewheel/quickstart.html>`_ guide.
27+
* To learn why experimentation may be the right tool to answer certain kinds of questions (and when it is probably the wrong tool) review our documentation on `Cyber Experimentation <https://sandialabs.github.io/firewheel/emulytics.html>`_.
28+
* An overview of FIREWHEEL including how FIREWHEEL can help a researcher implement high-quality emulation-based experiments, hardware requirements, software architecture, and known security security concerns is provided in our `System Overview <https://sandialabs.github.io/firewheel/system/index.html>`_.
29+
* An in-depth review of important FIREWHEEL concepts, is located `here <https://sandialabs.github.io/firewheel/concepts.html>`__.
30+
* The CLI reference documentation can be found `here <https://sandialabs.github.io/firewheel/cli/index.html>`__.
2931

3032

3133
****************************
@@ -36,17 +38,17 @@ If you have questions you'd like to ask the developers which our documentation d
3638

3739
Please report any bugs that you find on our GitHub page.
3840
We happily accept pull requests (PR), big or small.
39-
Please see the :ref:`contributing` for more information.
41+
Please see the `Contributor Guide <https://sandialabs.github.io/firewheel/developer/contributing.html>`_ for more information.
4042

41-
Any security-related issues should be reported directly to the developers at: ``firewheel AT sandia DOT gov`` (see :ref:`SECURITY <security>`) for more information.
43+
Any security-related issues should be reported directly to the developers at: ``firewheel AT sandia DOT gov`` (see `SECURITY.md <https://sandialabs.github.io/firewheel/developer/security.html>`_) for more information.
4244

4345
*******
4446
License
4547
*******
4648
Copyright 2024 National Technology & Engineering Solutions of Sandia, LLC (NTESS).
4749
Under the terms of Contract DE-NA0003525 with NTESS, the U.S. Government retains certain rights in this software.
4850

49-
Please see :ref:`LICENSE <license>` for more information.
51+
Please see `LICENSE <https://sandialabs.github.io/firewheel/developer/license.html>`_ for more information.
5052

5153
************************
5254
Research Using FIREWHEEL

pyproject.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,11 @@ dev = [
100100
]
101101

102102
[project.urls] # Optional
103-
"Homepage" = "https://www.sandia.gov/emulytics"
103+
homepage = "https://www.sandia.gov/emulytics"
104+
documentation = "https://sandialabs.github.io/firewheel/"
105+
repository = "https://github.com/sandialabs/firewheel/"
106+
issue_tracker = "https://github.com/sandialabs/firewheel/issues"
107+
changelog = "https://sandialabs.github.io/firewheel/developer/changelog.html"
104108

105109
[project.scripts]
106110
firewheel = "firewheel.cli.firewheel_cli:main"

src/firewheel/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from pathlib import Path
22

3-
__version__ = "2.6.0"
3+
__version__ = "2.7.0"
44

55
FIREWHEEL_PACKAGE_DIR = Path(__file__).parent

0 commit comments

Comments
 (0)